diff --git a/README.md b/README.md index 8d627f5..b714412 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,9 @@ [![Package Version](https://img.shields.io/hexpm/v/grom)](https://hex.pm/packages/grom) [![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/grom/) -## 🌟 A Gleamy Discord API Library -**Grom** is a Discord API wrapper written in Gleam. +## 🌟 A Sans-IO Discord REST API Wrapper + +**Grom** is a Discord REST API wrapper written in Gleam. It aims to be up-to-date and fully-featured, while also providing an API that is familiar to the Gleam programming language. @@ -12,21 +13,23 @@ Grom is considered __experimental__, and while it has released as v1.0.0, there These changes will either stem from the library's internal changes, or the Discord API's changes. Features: -* [x] Support for the Discord v10 gateway - connecting, reconnecting, resuming, heartbeating, sending/receiving events. -* [x] Full Discord REST API support in the library. ~~We don't talk about scheduled events 😂~~ +* [x] Full Discord REST API support in the library. * [x] Slash/message/user commands, interactions. * [x] Components v2, along with modal components. -* [x] Using the Erlang target, along with its amazing OTP library. -* [x] Monetization. (untested, hic sunt dracones) -* [x] Sharding. -* [ ] Voice support. +* [x] Supports all Gleam targets, including the browser. +* [x] Provides decoders and encoders for all objects, allowing you to create custom functionality. * [ ] Bearer token authentication. ## 💻 Examples You can see the examples [here](./examples). These will be rolled out over time. -## 🔨 Contributing -Check out the [good first issues](https://gitlab.com/grom-gleam/grom/-/issues?label_name%5B%5D=good%20first%20issue)! +**NOTE**: These are currently written for the old version 6. Please don't depend on them too much. +## 📋 See also: +* [ ] [agat](https://tangled.org/folospior.dev/agat) - a Discord Gateway client +* [ ] [nil](https://tangled.org/folospior.dev/nil) - a single-node HTTP client for grom +* [ ] [silent_unseen](https://tangled.org/silent_unseen) - a Discord Voice Gateway client +* [ ] [commandos](https://tangled.org/commandos) - an HTTP interactions middleware + ## 📃 Documentation Further documentation can be found at .