apkallone/README.md

49 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2024-10-22 20:48:44 +00:00
# apkallone
[![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/)
2024-10-22 22:28:08 +00:00
Bindings to the [Mastodon], [Pleroma], and [Misskey] APIs.
[Mastodon]: https://joinmastodon.org/
[Pleroma]: https://pleroma.social/
[Misskey]: https://misskey-hub.net/en/
2024-10-22 20:48:44 +00:00
```sh
2024-10-22 22:28:08 +00:00
gleam add apkallone@0
2024-10-22 20:48:44 +00:00
```
```gleam
import apkallone
2024-10-22 22:28:08 +00:00
import apkallone/mastodon/instance
2024-10-22 20:48:44 +00:00
pub fn main() {
2024-10-22 22:43:35 +00:00
let assert Ok(instance_info) =
2024-10-22 22:28:08 +00:00
apkallone.Client("https://tech.lgbt")
|> instance.get
2024-10-22 22:43:35 +00:00
io.debug(instance_info)
2024-10-22 20:48:44 +00:00
}
```
Further documentation can be found at <https://hexdocs.pm/apkallone>.
2024-10-22 22:33:39 +00:00
API documentation can be found at the official dev pages for [Mastodon], [Pleroma], and [Misskey].
2024-10-22 22:28:08 +00:00
[Mastodon]: https://docs.joinmastodon.org/api/
[Pleroma]: https://api.pleroma.social/
[Misskey]: https://misskey-hub.net/en/docs/for-developers/api/
2024-10-22 20:48:44 +00:00
## Development
2024-10-22 22:28:08 +00:00
This library is in development. Most functionality is unimplemented.
2024-10-22 22:33:39 +00:00
Currently **only the Erlang target is supported**, for lack of a target-agnostic HTTP client.
2024-10-22 22:28:08 +00:00
## Planned features
- [ ] Authenticated requests.
- [ ] User-provided HTTP client.
- [ ] The full Mastodon API.
- [ ] The full Pleroma/Akkoma API.
- [ ] The full Misskey/IceShrimp/Sharkey API.