update doc

This commit is contained in:
Gabriel 2022-02-28 22:26:37 -05:00
parent 04726d77c1
commit 481d510c07
3 changed files with 21 additions and 2 deletions

1
.gitignore vendored
View file

@ -1,2 +1,3 @@
data.json
session.txt
__pycache__

View file

@ -1 +1,19 @@
Setting up repo
# 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)

BIN
example.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB