README and example rendering of Trending arXiv

Smerity · Sep 11, 2016 · d9d33a2 · d9d33a2
1 parent 1fc8327
commit d9d33a2
Show file tree

Hide file tree

Showing 2 changed files with 1,769 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+# Trending arXiv
+
+Keep track of the papers and the tweet mini-commentaries that your friends are discussing on Twitter.
+
+To run:
+
++ Set up the config file with Twitter API credentials and Twitter users to follow
++ Install Python requirements
++ Create database (`python create_db.py`)
++ Run development server (`run_dev_server.sh`)
++ Refresh to follow your friends :)