From 7ef58d08ac98cbc789c6cd236b073ad4de082614 Mon Sep 17 00:00:00 2001
From: Elliu <goyard.louis@gmail.com>
Date: Tue, 22 Dec 2020 16:30:13 +0100
Subject: [PATCH] Updating readme
---
README.md | 23 +++++++++++++++++++++--
launch.py | 4 ++--
2 files changed, 23 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 833bf67..6b1787a 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,21 @@
-# KumikoBot
-A discord bot that posts pictures of Oumae Kumiko from Hibike Euphonium
+# SMAW (Show Me A Waifu)
+A discord bot that posts pictures of requested waifus.
+Extended from [KumikoBot](https://github.com/TheSmallBlue/KumikoBot) made by [TheSmallBlue](https://github.com/TheSmallBlue)
+
+
+## Requirements
++ python-praw
++ python-discord
+
+
+## How to use
+Will respond to `show me a xxx` or `show me an xxx`, `xxx` being the name of a waifu in the csv.
+
+To get a list of the available waifus (from discord), send `show me an help`
+
+
+## How to launch
+1. `cp .env.example .env`
+1. Fill in the .env with your reddit/discord credentials
+1. Fill a `subreddits.csv` file, with lines of `waifus,subreddits` to serve
+1. `python launch.py`
diff --git a/launch.py b/launch.py
index 3a0ba38..5b9cac8 100644
--- a/launch.py
+++ b/launch.py
@@ -84,8 +84,8 @@ async def on_ready():
async def on_message(message):
if message.author == client.user:
return
- if message.content.lower() == "show me a help":
- mess = "Usage : ``show me a xxxx``\nCurrently, I can show :```"
+ if message.content.lower() == "show me an help":
+ mess = "Usage : ``show me a xxxx`` or ``show me an xxxx``\nCurrently, I can show :```"
for entry in subreddits.values():
mess += entry.name + " with a picture from r/" + entry.subName + "\n"
mess += "```"
--
GitLab