diff --git a/README.md b/README.md index fac6c69..993f723 100644 --- a/README.md +++ b/README.md @@ -3,22 +3,46 @@ [![Package Version](https://img.shields.io/hexpm/v/apkallone)](https://hex.pm/packages/apkallone) [![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/apkallone/) +Bindings to the [Mastodon], [Pleroma], and [Misskey] APIs. + +[Mastodon]: https://joinmastodon.org/ +[Pleroma]: https://pleroma.social/ +[Misskey]: https://misskey-hub.net/en/ + ```sh -gleam add apkallone@1 +gleam add apkallone@0 ``` ```gleam import apkallone +import apkallone/mastodon/instance pub fn main() { - // TODO: An example of the project in use + let assert Ok(instance) = + apkallone.Client("https://tech.lgbt") + |> instance.get + + io.debug(instance) } ``` Further documentation can be found at . +API documentation can be found at the official pages for [Mastodon], [Pleroma], and [Misskey]. + +[Mastodon]: https://docs.joinmastodon.org/api/ +[Pleroma]: https://api.pleroma.social/ +[Misskey]: https://misskey-hub.net/en/docs/for-developers/api/ + ## Development -```sh -gleam run # Run the project -gleam test # Run the tests -``` +This library is in development. Most functionality is unimplemented. + +Currently only the Erlang target is supported, for lack of a target-agnostic HTTP client. + +## Planned features + +- [ ] Authenticated requests. +- [ ] User-provided HTTP client. +- [ ] The full Mastodon API. +- [ ] The full Pleroma/Akkoma API. +- [ ] The full Misskey/IceShrimp/Sharkey API.