add note about adding commands for development

4 years ago · 95b8405686
parent 3e02d82599
commit 95b8405686
1 changed files with 4 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -47,3 +47,7 @@ There are 2 modules in this repo:
 - `admin` - management commands

 To use them, ensure you're in the virtualenv and run `python3 -m tipbot` or `python3 -m admin`
+
+## Development
+
+To add more commands, create a new Python file under [tipbot/commands](tipbot/commands); copy another one for an example. Add another import for the command function in [tipbot/commands/__init__.py](tipbot/commands/__init__.py) and add the command to the `all_commands` dictionary in the same file.