diff --git a/README.md b/README.md index e2a751c..4706b06 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ ## Table of contents: -* [Wiki](https://github.com/tubearchivist/tubearchivist/wiki) with [FAQ](https://github.com/tubearchivist/tubearchivist/wiki/FAQ) +* Docs: [Wiki](https://github.com/tubearchivist/tubearchivist/wiki), [FAQ](https://github.com/tubearchivist/tubearchivist/wiki/FAQ) and [API](https://github.com/tubearchivist/tubearchivist/tree/master/tubearchivist/api) * [Core functionality](#core-functionality) * [Screenshots](#screenshots) * [Problem Tube Archivist tries to solve](#problem-tube-archivist-tries-to-solve) diff --git a/tubearchivist/api/README.md b/tubearchivist/api/README.md index 00e929f..eb182de 100644 --- a/tubearchivist/api/README.md +++ b/tubearchivist/api/README.md @@ -2,8 +2,9 @@ Documentation of available API endpoints. Note: -- This is very early stages and will change! -- Check the commit history to see if a documented feature is already in your release +- This has changed in the past and will change again while building out additional integrations and functionality. +- All changes to the API are marked with a `[API]` keyword for easy searching, for example search for [commits](https://github.com/tubearchivist/tubearchivist/search?o=desc&q=%5Bapi%5D&s=committer-date&type=commits). You'll find the same in the [release notes](https://github.com/tubearchivist/tubearchivist/releases). +- Check the commit history and release notes to see if a documented feature is already in your release. ## Table of contents - [Authentication](#authentication)