Skip to content
Repository creating the umbrella documentation for all crux libraries
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
apps
config
.formatter.exs
.gitignore
.gitmodules
.travis.yml
README.md
mix.exs
mix.lock

README.md

Crux - Umbrella Repository

This repository is responsible for generating the umbrella documentation available here: https://crux.randomly.space

Child Repositories:

Crux Gateway

Handles Discord's sharded gateway api, including reconnecting, zombie connections, and ratelimiting.
Forwards normalized packets as maps with atom keys via gen_stage producers. (One per shard)

Links:

Crux Rest

Handles Discord's RESTful bot api, including queues, rate limits, and retries.
Returns transformed Crux.Structs directly. (Blocks calling process when rate limited)

Links:

Crux Structs

Provides Elixir Structs for Discord's api objects, as well as helper structs.

Links:

Crux Cache

Provides caches to add, fetch, update, and remove Crux.Structs. Also provides a behaviour to implement custom caches which may override the default ones. (For example using redis instead of ets)

Links:

You can’t perform that action at this time.