update the readme to be a bit more useful in how to run it.
parent
42ea503b27
commit
0456741651
13
README.md
13
README.md
|
@ -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.
|
||||
|
||||
|
|
Loading…
Reference in New Issue