From 1fc35c8276ad8d162e59c7452286974c258c17c5 Mon Sep 17 00:00:00 2001
From: Abhinav Sarkar <abhinav.sarkar@gmail.com>
Date: Thu, 2 Sep 2010 00:56:19 +0530
Subject: [PATCH] fixed README

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..568b500
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# clj-twitter-feelings
+
+Shows how people on twitter are feeling, in real-time.
+Meant to be an example of a swing app in Clojure.
+
+## Usage
+
+Download the standalone jar and run it like:
+
+    java -jar clj-twitter-feelings-1.0.0-standalone.jar
+
+## How it works
+
+* Access the twitter sample tweet stream 
+* Find the feeling related adjectives in the tweet status and find their type
+(Positive, Neutral, Negative)
+* Keep the count of the adjective types in a sliding windows of tweets
+* Show the count on the UI
+    
+## License
+
+Copyright (C) 2010 Abhinav Sarkar <abhinav@abhinavsarkar.net>
+
+Distributed under the Eclipse Public License, the same as Clojure.