diff --git a/README.md b/README.md index 39e3d14..7e7037a 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,13 @@ 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`: @@ -9,10 +16,22 @@ The package can be installed by adding `crux_rest` to your list of dependencies ```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/). \ No newline at end of file +## 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{...}, + ... + } +``` \ No newline at end of file