From 3e02d8259960d4d2f663554c96926a001828773f Mon Sep 17 00:00:00 2001 From: lza_menace Date: Wed, 5 Aug 2020 22:54:28 -0700 Subject: [PATCH] update readme with new info re: module script execution --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e6efafb..fe159f8 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,13 @@ pip install -r requirements.txt # setup secrets in config file outside of git cp tipbot/config.example.py tipbot/config.py vim !$ - -# run it -python3 tipbot/tipbot.py ``` + +## Usage + +There are 2 modules in this repo: + +- `tipbot` - the Telegram bot process +- `admin` - management commands + +To use them, ensure you're in the virtualenv and run `python3 -m tipbot` or `python3 -m admin`