Packages

grom

7.0.0-beta.2.0
7.0.0-beta.2.0 7.0.0-beta.1.1 7.0.0-beta.1.0 6.0.0 5.1.5 5.1.4 5.1.3 5.1.2 5.1.1 5.1.0 5.0.0 4.0.0 3.0.1 3.0.0 2.0.0 1.0.2 1.0.0

A Sans-IO Discord REST API Wrapper

HexDocs Report package

Current section

Files

Jump to
Readme
17 Versions
8 Dependencies
Dependants
Files
Activity
grom README.md
Raw

README.md 

# grom



[![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 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.



Grom is considered __experimental__, and while it has released as v1.0.0, there are **many** breaking changes to come.

These changes will either stem from the library's internal changes, or the Discord API's changes.



Features:

* [x] Full Discord REST API support in the library.

* [x] Slash/message/user commands, interactions.

* [x] Components v2, along with modal components.

* [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.



**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 <https://hexdocs.pm/grom>.