docs: use absolute GitHub URLs in README, add demo video link

Relative links (docs/, LICENSE, MIT-license-tubesage.md) resolve
against community.obsidian.md on the plugin's community page and 404.
Switch them to absolute github.com URLs so they work on both GitHub
and the community site. Add a link to the demo MP4 hosted in the repo.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
Richard McCorkle 2026-05-18 09:58:43 +02:00
parent 28ff432533
commit 1d8e6cef0c

View file

@ -2,6 +2,8 @@
TubeSage is an Obsidian plugin that converts YouTube videos into structured notes using large language models. It extracts transcripts, generates summaries, and can add timestamped links back to specific moments in the video.
**Demo:** [Watch the walkthrough video](https://github.com/rmccorkl/TubeSage/blob/main/docs/TubeSage.mp4) (MP4, hosted on GitHub).
## Quick Start
### Installation
@ -92,8 +94,8 @@ When enabled, each section heading includes a link that opens the YouTube video
- **Error utilities** (`src/utils/error-utils.ts`): error categorization and retry logic.
Architecture diagrams are in the `docs/` directory:
- [Workflow Diagram](docs/workflow-diagram.md)
- [Data Flow Diagram](docs/data-flow-diagram.md)
- [Workflow Diagram](https://github.com/rmccorkl/TubeSage/blob/main/docs/workflow-diagram.md)
- [Data Flow Diagram](https://github.com/rmccorkl/TubeSage/blob/main/docs/data-flow-diagram.md)
## Privacy & Security
@ -125,7 +127,7 @@ The plugin also bundles `langsmith` as a transitive dependency of `@langchain/co
## License
This project is licensed under the MIT License — see the [LICENSE](LICENSE) file. A YouTube content-usage disclaimer is included in [MIT-license-tubesage.md](MIT-license-tubesage.md).
This project is licensed under the MIT License — see the [LICENSE](https://github.com/rmccorkl/TubeSage/blob/main/LICENSE) file. A YouTube content-usage disclaimer is included in [MIT-license-tubesage.md](https://github.com/rmccorkl/TubeSage/blob/main/MIT-license-tubesage.md).
## Support & Contribution