diff --git a/.gitignore b/.gitignore index 6c31354..1d9b6a4 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ data.json -session.txt \ No newline at end of file +session.txt +__pycache__ \ No newline at end of file diff --git a/README.md b/README.md index f5664eb..4b73ee3 100644 --- a/README.md +++ b/README.md @@ -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) + + diff --git a/example.png b/example.png new file mode 100644 index 0000000..aa0e0c2 Binary files /dev/null and b/example.png differ