update the readme to be a bit more useful in how to run it.

master
Rachel Fae Fox 2022-11-07 21:59:34 -05:00
parent 42ea503b27
commit 0456741651
1 changed files with 10 additions and 3 deletions

View File

@ -32,7 +32,14 @@ config :nostrum,
num_shards: :auto
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/discordirc](https://hexdocs.pm/discordirc).
## Running
This is still in heavy development so i haven't handled running it as
a release or anything special like that you can still run it with iex.
```shell
$ iex -S mix
```
This does have advantages, for example, if you need to upgrade your
bot you can just type `recompile` and update it without restarting.