Updating readme and main source

README.md

@@ -1,3 +1,19 @@
 # python-app-rocketbot
 
-Experimental Discord bot written in Python and hosted in Django
+Experimental Discord bot written in Python.
+
+## Usage
+
+* To see the list of commands, type `$rb_help`.
+* To get help on a specific command, type `$rb_help command` (don't prefix the command name you want help on)
+* To get help on a command group, type `$rb_help group`
+* To get help on a subcommand in a group, type `$rb_help group command`
+* To see if the bot is alive, type `$rb_hello`
+
+## Setup
+
+Currently the bot is just run in the console locally. It blocks until Ctrl+C is pressed. Before running, you must copy config.py.sample to config.py and fill in the "client_token" value. To get a token, visit https://discord.com/developers/applications and create an application. Then create a bot for the application and enable the "server members intent". Click the "copy" button in the "token" section near the top and paste this value into config.py's "client_token" attribute.
+
+Create a "config" subdirectory under your source folder. This is where guild-specific configuration is written as JSON files.
+
+To start, run `python3 rocketbot.py`. Then visit https://discord.com/oauth2/authorize?client_id=[application_id]&scope=bot&permissions=395204357318, where [application_id] is the "application id" value on your app configuration "general information" page. Once invited, test if the bot is working by typing `$rb_hello` in your Discord server.

rocketbot.py

@@ -1,6 +1,6 @@
 """
-Rocketbot Discord bot. Relies on a configured config.py (copy config.py.sample for a template) and
-the sqlite database rocketbot.db (copy rocketbot.db.sample for a blank database).
+Rocketbot Discord bot. Relies on a configured config.py (copy config.py.sample
+for a template).
 
 Author: Ian Albert (@rocketsoup)
 Date: 2021-11-11
@@ -18,6 +18,10 @@ from cogs.urlspamcog import URLSpamCog
 
 CURRENT_CONFIG_VERSION = 3
 if (CONFIG.get('__config_version') or 0) < CURRENT_CONFIG_VERSION:
+    # If you're getting this error, it means something changed in config.py's
+    # format. Consult config.py.sample and compare it to your own config.py.
+    # Rename/move any values as needed. When satisfied, update "__config_version"
+    # to the value in config.py.sample.
     raise RuntimeError('config.py format may be outdated. Review ' +
         'config.py.sample, update the "__config_version" field to ' +
         f'{CURRENT_CONFIG_VERSION}, and try again.')