diff --git a/README.md b/README.md index 46fe7c7..53f76e2 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ -# 2 Chainz Rest +# 2 Chainz Twitter Bot +Posts weekly tweets to the [@chainz_bot](https://twitter.com/chainz_bot) twitter account. More information about this project at [2.chainz.rest](2.chainz.rest) + +## Usage + +You need to add your twitter api keys to a `keys.py` file in this directory with the following format: + +```python +keys = { + "API": "API_KEY_HERE", + "API_SECRET": "API_SECRET_KEY_HERE", + "TOKEN": "TOKEN_KEY_HERE", + "TOKEN_SECRET": "TOKEN_SECRET_KEY_HERE", +} +```