From 9e85ec0de300efc160a7f1224cc271004a7fc0b9 Mon Sep 17 00:00:00 2001 From: Rachel Fae Fox Date: Thu, 10 Nov 2022 14:51:02 -0500 Subject: [PATCH] update readme --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 747b0b5..a3df9a2 100755 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Relay your discord server to irc via avian carrier. ## Installation -you need to configure this with a dev.exs like such +you need to configure this with a dev.exs / prod.exs like such ```elixir import Config @@ -32,13 +32,15 @@ config :nostrum, ``` ## 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 +$ MIX_ENV="prod" mix run --no-halt +``` + +if you're going to be hacking on it, or want the ability to update without restarting, I recommend you run it in 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. +to update your bot while running in iex just type `recompile`.