Update README and add aiohttp dependency

aiohttp has a weird issue when installing with pipenv. A workaround is
added in the README.md to at least cover that case when it comes time to
deploy on a real server.

Signed-off-by: Alek Ratzloff <alekratz@gmail.com>
This commit is contained in:
2022-05-23 19:38:21 -07:00
parent 240e4e5f29
commit 78a4c5558d
3 changed files with 380 additions and 3 deletions

View File

@@ -5,11 +5,22 @@
This is an IRC chatbot that can be extended with plugins. Omnibot comes with a
few plugins pre-packaged.
# Configuration
# Configuring and running
Copy the `config.example.toml` file to `config.toml` and fill it out for your needs.
## How do I add multiple servers?
Simply put, you don't. Run another instance of the bot with its own
configuration if you want to do that.
configuration if you want to do that.
## Running
1. Install dependencies `pipenv install`
2. Run `pipenv run python -m omnibot`
# Troubleshooting
## aiohttp fails to install
`pipenv run pip install "aiohttp[speedups]"`