near/computersandblues.lodestone
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add note about API compatibility

Browse source
This commit is contained in:
arne 2025-11-21 09:07:08 +01:00
commit c35eb6d11e
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -4,6 +4,16 @@ Lodestone helps you navigate the Fediverse.
It gives you a tool to quickly search through your favorite posts, and helps you rediscover the things you found relevant. It gives you a tool to quickly search through your favorite posts, and helps you rediscover the things you found relevant.
## Fediverse Software Compatibility
The software is actively being tested against [Mastodon](https://docs.joinmastodon.org/) and compatible forks like [Hometown](https://github.com/hometown-fork/hometown/). The API surface that's used by this tool is quite small at the moment:
- `POST /api/v1/apps`
- `POST /oauth/token`
- `GET /api/v1/favourites`
It is tested to work with `Note` activities. Even though other activites are currently not tested, any effort to improve compatibility is welcome.
## Building a release ## Building a release
Before anything, make sure JS dependencies are installed: Before anything, make sure JS dependencies are installed: