From 045674165166ae95c597b596edaaf2272cd9cbaa Mon Sep 17 00:00:00 2001 From: Rachel Fae Fox Date: Mon, 7 Nov 2022 21:59:34 -0500 Subject: [PATCH] update the readme to be a bit more useful in how to run it. --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 644f71a..9bc2aa8 100755 --- a/README.md +++ b/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.