matty/ncd-fe
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

pl-api: Update docs, build docs as part of CI

Browse Source 
Signed-off-by: marcin mikołajczak <git@mkljczk.pl>
This commit is contained in:
marcin mikołajczak
2024-10-29 20:12:14 +01:00
parent 49b4f87534
commit 21fec0134c
7 changed files with 376 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/pl-api/README.md
View File

@ -1,6 +1,8 @@
# `pl-api`
A library for interacting with Mastodon API-compatible servers, focused on support for projects extending the official Mastodon API.
A JavaScript library for interacting with Mastodon API-compatible servers, focused on support for projects extending the official Mastodon API.
`pl-api` attempts to abstract out the implementation details when supporting different backends, implementing the same features in different ways. It uses [Valibot](https://valibot.dev/) to ensure type safety and normalize API responses.
> This project should be considered unstable before the 1.0.0 release. I will not provide any changelog or information on breaking changes until then.