Documentation

docs/README.md

@@ -1,4 +1,8 @@
 # Butterrobot Documentation
 
 ## Index
-- [Creating a Plugin](./creating-a-plugin.md)
+- [Contributing](./contributing.md)
+- [Platforms](./platforms.md)
+- Plugins
+    - [Creating a Plugin](./creating-a-plugin.md)
+    - [Provided plugins](./plugins.md)

docs/contributing.md

@@ -0,0 +1,23 @@
+## Contributing
+
+To run the project locally you will need [poetry](https://python-poetry.org/).
+
+```
+git clone git@github.com:fmartingr/butterrobot.git
+cd butterrobot
+poetry install
+```
+
+Create a `.env-local` file with the required environment variables, you have [an example file](.env-example).
+
+```
+SLACK_TOKEN=xxx
+TELEGRAM_TOKEN=xxx
+...
+```
+
+And then you can run it directly with poetry
+
+```
+docker run -it --rm --env-file .env-local -p 5000:5000 -v $PWD/butterrobot:/etc/app/butterrobot local/butterrobot python -m butterrobot
+```

docs/platforms.md

@@ -0,0 +1,8 @@
+## Supported platforms
+
+TODO: Create better actions matrix
+
+| Name            | Receive messages | Send messages |
+| --------------- | ---------------- | ------------- |
+| Slack (app)     | Yes              | Yes           |
+| Telegram        | Yes              | Yes           |

docs/plugins.md

@@ -0,0 +1,11 @@
+## Provided plugins
+
+### Development
+
+- `!ping`: Say `!ping` to get response with time elapsed.
+
+### Fun and entertainment
+
+
+- Lo quito: What happens when you say _"lo quito"_...? (Spanish pun)
+- Dice: Put `!dice` and wathever roll you want to perform.