commit 6b8bf613d5e96b4bcb0175c51722797b2a21f593 parent 0d20a34ae314dc6d47a053d6f1aa07d9c09f44a9 Author: Marcel <mtrnord1@gmail.com> Date: Mon, 17 Feb 2020 19:34:54 +0100 Add basic README.md Took 3 minutes Diffstat:
| A | README.md | | | 7 | +++++++ |
1 file changed, 7 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,7 @@ +# auto-invite-matrix-bot + +## Usage +1. Install rust on your system +2. Make a config file according to the config_example.yml +3. Install the application using `cargo install --git https://github.com/MTRNord/auto-invite-matrix-bot.git` +4. Run it with `auto-invite-matrix-bot` with an addition `--config` argument to point to your config file