Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SpaceEEC committed May 27, 2018
1 parent 568c001 commit 78d2604
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,36 @@

Package providing rest functions and rate limiting for the [Discord API](https://discordapp.com/developers).

## Useful links

- [Latest Release Documentation](https://hexdocs.pm/crux_rest/)
- [Github](https://github.com/SpaceEEC/crux_rest/)
- [Changelog](https://github.com/SpaceEEC/crux_rest/releases/tag/0.1.3/)
- [Development Documentation](https://crux.randomly.space/)

## Installation

The package can be installed by adding `crux_rest` to your list of dependencies in `mix.exs`:

```elixir
def deps do
[
{:crux_rest, "~> 0.1.1"}
{:crux_rest, "~> 0.1.3"}
]
end
```

The docs for the latest release can be found at [https://hexdocs.pm/crux_rest](https://hexdocs.pm/crux_rest).
Unified docs of all libraries for their respective latest commits can be found [here](https://crux.randomly.space/).
## Usage

After providing a token to use via either your [config.exs](/config/config.exs), [`Application.put_env/3`](https://hexdocs.pm/elixir/Application.html#put_env/3), or [`:application.set_env/3`](http://erlang.org/doc/apps/kernel/application.html#set_env-3) freely use the functions provided by the [`Crux.Structs.Rest`](/lib/rest.ex) module.

For example:

```elixir
iex> Crux.Structs.Rest.create_message(445290716198076427, content: "Hello there!")
%Crux.Structs.Message{
content: "Hello there!",
author: %Crux.Structs.User{...},
...
}
```

0 comments on commit 78d2604

Please sign in to comment.