Add .gitignore and README.md

idea404 · Jan 23, 2022 · d075faa · d075faa
1 parent ced0d3a
commit d075faa
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,7 @@
+# folders
+.idea
+src/rankr/archive
+
+# files
+setup/config.yaml
+setup/keys.yaml
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+### Fururankr
+#### Twitter trader trade monitor
+
+To run the program start your local environment with Python 3.6+ 
+and install requirements.txt. Then activate your env and, from `/src` run:
+
+```commandline
+python -m interface.cli.client
+```
+
+For questions: [[email protected]](mailto:[email protected])