Permalink
Browse files

updated readme with Rx status

  • Loading branch information...
1 parent 1e15089 commit e7e4c1d50751bebcd0fa035f759b20a002f7909f @sdether committed May 24, 2010
Showing with 8 additions and 2 deletions.
  1. +8 −2 README.rst
View
@@ -1,6 +1,6 @@
-Firkin 0.1
+Firkin 0.2
==========
-An embeddable Key/Value store for .NET and mono using immutable log journalling and in-memory hashing as its storage back end. Inspired by the Basho BitCask paper located at http://downloads.basho.com/papers/bitcask-intro.pdf
+An embeddable Key/Value store for .NET and mono using immutable log journalling and in-memory hashing as its storage back end. Inspired by the Basho BitCask paper located at http://downloads.basho.com/papers/bitcask-intro.pdf. Supports IObservable interface from the Rx framework with Firkin.Reactive, allowing changes to be tailed.
Uses
====
@@ -10,6 +10,10 @@ Installation
============
Currently using the driver in the GAC is not supported. Simply copy the driver assembly somewhere and reference it in your project. It should be deployed in your application's bin directory. It is not necessary to reference the test assemblies.
+Dependencies
+============
+Firkin.Reactive, Firkin.Reactive.Test and Firkin.Test.Perf require the Rx Framework to be installed (http://msdn.microsoft.com/en-us/devlabs/ee794896.aspx). Firkin itself does not require Rx.
+
Patches
=======
Patches are welcome and will likely be accepted. By submitting a patch you assign the copyright to me, Arne F. Claassen. This is necessary to simplify the number of copyright holders should it become necessary that the copyright need to be re-assigned or the code re-licensed. The code will always be available under an OSI approved license.
@@ -65,6 +69,8 @@ The write/random query test of all users from the StackOverflow dump included in
41k writes/second
80k queries/second
+
+Using ObservableFirkinHash currently adds a ~20% perf penalty for writes, since it checks the index to determine whether the action is a add or change.
Contributors

0 comments on commit e7e4c1d

Please sign in to comment.