From d0b55ab447ccaa163e0d023297fef25cf80849d2 Mon Sep 17 00:00:00 2001 From: Abhinav Sarkar Date: Thu, 2 Sep 2010 01:08:56 +0530 Subject: [PATCH] added more info in README --- README.md | 33 ++++++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 568b500..7a4b8ad 100644 --- a/README.md +++ b/README.md @@ -5,20 +5,39 @@ Meant to be an example of a swing app in Clojure. ## Usage -Download the standalone jar and run it like: +Download [the standalone jar][1] and run it like: java -jar clj-twitter-feelings-1.0.0-standalone.jar +Or checkout the source and + +* build using leiningen and run using Java: + + git clone git://github.com/abhin4v/clj_twitter_feelings.git clj_twitter_feelings + cd clj_twitter_feelings + lein deps && lein uberjar + java -jar target/clj-twitter-feelings-1.0.0-standalone.jar + +* OR run using leiningen-run plugin: + + git clone git://github.com/abhin4v/clj_twitter_feelings.git clj_twitter_feelings + cd clj_twitter_feelings + lein deps && lein run + ## 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 +* Access the twitter sample tweet stream (the users need to input their twitter +credentials for accessing the stream) +* Find the feeling related adjectives in each tweet's status text and lookup +their type (Positive, Neutral, Negative) against the included list of adjectives +in text files +* Keep the count of the adjective types in a sliding window of tweets * Show the count on the UI - + ## License -Copyright (C) 2010 Abhinav Sarkar +Copyright (C) 2010 Abhinav Sarkar <abhinav@abhinavsarkar.net> Distributed under the Eclipse Public License, the same as Clojure. + + [1] http://github.com/downloads/abhin4v/clj_twitter_feelings/clj-twitter-feelings-1.0.0-standalone.jar \ No newline at end of file