commit 170f39b9f45ca6c2537983442d10593841029278 parent 71ac49b36f1e9402109b0c334bbdea380bda803b Author: JayVii <jayvii[AT]posteo[DOT]de> Date: Sun, 27 Oct 2024 16:19:59 +0100 feat: document API Diffstat:
| M | README.md | | | 16 | +++++++++++++++- |
1 file changed, 15 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md @@ -63,13 +63,27 @@ this on the screenshot below): ### Search -Remmori also has a simple search integrated. It will simply match the keywords +Rememori also has a simple search integrated. It will simply match the keywords you type into the search field with all notes' content and title. It then provides you with a list of all notes that had matches, sorted by the number of matches.  +### More features + +Rememori provides simple API endpoints that can be used via `POST` and `GET` +requests. + +The `/api/new.php` endpoint will create a new note given the `user`, `token` and +`content` arguments as well as the optional `category` argument. + +The `/api/rss.php` endpoint will return an +[Atom RSS Feed](https://en.wikipedia.org/wiki/Atom_(Web_standard)) sorted by +time/date of all notes or for a specific category (for example a `ReadLater` +category). It requires the `user` and `token` arguments as well as the optional +`category` argument. + ## Setup Coming soon...