add readme

Georgetown-IR-Lab · Nov 13, 2013 · 15cd960 · 15cd960
1 parent 13ec515
commit 15cd960
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,7 @@
+# Summary
+Hosebird client for storing Tweets from the [English-speaking parts of North America](https://andrewyates.net/boundingbox.html?sw=24.846565,-166.992188&ne=70.020587,-53.789063) (using Twitter's statuses/filter API).
+
+# Usage
+1. Edit consumer.key, consumer.secret, access.token, access.token.secret, and output.directory in *pom.xml*
+2. Build: mvn install
+3. Run: mvn exec:java