README and sample changes

Signed-off-by: Etzelia <etzelia@hotmail.com>
2020-04-17 21:35:42 -05:00 · 2020-04-17 21:35:42 -05:00 · 6663fe275d
parent 718a2d3cfb
commit 6663fe275d
2 changed files with 8 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,6 @@
+# lurk
+
+A reddit lurker used to notify a Discord channel via webhook 
+whenever a matching submission is made.
+
+See the [example config](lurk.sample.toml).
--- a/lurk.sample.toml
+++ b/lurk.sample.toml
@ -2,9 +2,11 @@
 app_name = "Lurk"
 version = "0.1"

+# https://www.reddit.com/prefs/apps
 client_id = ""
 client_secret = ""

+# Reddit credentials
 username = "24CC-Official"
 password = ""