nerve/README.md
2022-02-28 22:26:37 -05:00

19 lines
500 B
Markdown

# Nerve
## A matrix receptionist bot
## How to get started
1. Register a matrix bot on your homeserver
2. Grab [data-example.json](./data-example.json) and modify it with your bot's credentials
3. Save as `data.json`
4. Create your own questions & answers and setup your keywords
5. Run the bot `python main.py`
## details
* The bot will listen to `!faq` and post the entire FAQ
* Based on selected keywords it will include relevant questions & answers
![matrix room screenshot](example.png)