Permalink
Browse files

Updated README with new information.

  • Loading branch information...
1 parent 04b1a14 commit 38e407156413a3308113ddcc341145d7798fbe1d @seancribbs committed May 16, 2011
Showing with 11 additions and 10 deletions.
  1. +11 −10 README.textile
View
@@ -1,16 +1,18 @@
h1. yakriak
-A simple web-based chatroom app. Designed as a proof-of-concept for
-Ben Black's Riak training at VelocityConf 2010.
+A simple web-based chatroom app. Designed as a proof-of-concept for Ben Black's Riak training at VelocityConf 2010.
h2. Features / Problems
-* Everything is stored and served out of Riak. Take that, couchapps!
-* Tested in Chrome, Safari, Firefox. Other browsers, caveat emptor.
-* Remembers your login credentials via unencrypted cookies.
-* Randomizes the polling interval to avoid dogpile effects.
-* Uses full-bucket map-reduce, so won't perform well at huge numbers of messages.
-* Use gravatar, should you decide not to remain anonymous.
+* Everything is stored and served out of Riak. No special abstraction. Take that, couchapps!
+* Browser Compatibility:
+** WebKit-based (Chrome, Safari)
+** Firefox 3.6 and 4.0
+** MSIE8, maybe 7 (tested via 8's IE7 mode)
+* Remembers your login credentials via unencrypted cookies (not transmitted).
+* Randomizes the polling interval to avoid thundering-herd effects.
+* Uses full-bucket map-reduce, so won't perform well at huge numbers of messages. Future work could change to use key-filters but would still incur the price of list-keys.
+* Your email address will be used for Gravatar, should you decide not to remain anonymous.
h2. Setup
@@ -21,8 +23,7 @@ h2. Setup
h2. Learn more
-Read the source! The majority of the work is in @yakriak.js@, and the
-map and reduce functions in the @yakmr/@ directory.
+Read the source! The majority of the work is in @yak/yakriak.js@, and the map and reduce functions in the @yakmr/@ directory.
h2. Credit where credit's due

0 comments on commit 38e4071

Please sign in to comment.