Permalink
Browse files

added more stuff to readme

  • Loading branch information...
1 parent fca3e87 commit 2f6590a1fb43bb570658aab9f60e1df9e403d761 @javasoze committed Feb 22, 2011
Showing with 5 additions and 3 deletions.
  1. +5 −3 README.md
View
@@ -1,5 +1,6 @@
What is Chirper?
==================
+([http://javasoze.github.com/chirper/](http://javasoze.github.com/chirper/))
Chirper is a real time tweet search engine (written in Scala) using open source technology built by the [LinkedIn SNA team](http://sna-projects.com):
@@ -8,7 +9,7 @@ Chirper is a real time tweet search engine (written in Scala) using open source
* [Voldemort - Distribute Key/Value Store](http://sna-projects.com/voldemort/)
* [Sensei - Distributed Realtime Faceted Search System](http://sna-projects.com/sensei/)
-Although the amount of code is minimal, the system can scale horizontally infinitely by leveraging the distributed system above.
+Although the amount of code is minimal, the system can scale horizontally infinitely by leveraging the distributed systems above. See this [blog post](http://sna-projects.com/blog/2011/02/build-a-distributed-realtime-tweet-search-system-in-no-time-part-12/) on design considerations.
### Build and run the system:
@@ -37,12 +38,12 @@ The order of class to be run are:
1. [2] - Zookeeper
2. [3] - Kafka
3. [4] - Voldemort
-4. [1] - Streamer (Make sure your twitter username/password is set in the [config file](https://github.com/javasoze/chirper/blob/master/config/TwitterStreamer.conf))
+4. [1] - Streamer
5. [5] - Search Node
Each of the components are pre-configured, details see [configs](https://github.com/javasoze/chirper/tree/master/config).
-The last thing to run is a Restful servlet and interacts with the system (Comes with a beautiful UI):
+The last thing to run is a Restful servlet that interacts with the system (Comes with a beautiful UI):
chirper$ sbt
[info] Building project Chirper 1.0 against Scala 2.8.0
@@ -53,3 +54,4 @@ Now you can point to:
* [Chirp UI - http://localhost:8080](http://localhost:8080)
* [Chirp API - http://localhost:8080/search?q=](http://localhost:8080/search?q=)
+

0 comments on commit 2f6590a

Please sign in to comment.