aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e8b6e4b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# Snooper
+A Python program to do reddit user analysis / profiling using PRAW
+### Install the required dependencies
+`pip3 install -r requirements.txt`
+### Change Configuration
+Edit the file `snooper.py` with your preffered text editor and replace `PrudentWish` with your desired username
+### To-Do
+* Add More Features
+* Provide username through arg-parse
+* Clean up the code