README.md in rico-0.1.0 vs README.md in rico-0.2.0
- old
+ new
@@ -1,7 +1,9 @@
# Rico
+[![Build Status](https://secure.travis-ci.org/jcoene/rico.png?branch=master)](https://travis-ci.org/jcoene/rico)
+
Rico provides primative data types on Riak.
## Installation
Add rico to your Gemfile and `bundle install`:
@@ -32,15 +34,15 @@
follows.length # => 0
```
## Configuration
-By default, Rico uses a generic Riak::Client instance for operations. You can specify your own (perhaps inside of a rails initializer) like so:
+By default, Rico uses a generic Riak::Client instance for operations. You can specify your own options for the Riak client (perhaps inside of a rails initializer) like so:
```ruby
Rico.configure do |c|
- c.riak = Riak::Client.new(http_port: 1234, ...)
+ c.options = { http_port: 1234, ... }
end
```
You can also provide a namespace to be used as a key prefix:
@@ -114,11 +116,10 @@
Data is persisted at operation time. For example, List#add(5) will immediately update the record in Riak. It'd generally be wise to compute a list of values to be added or removed and then issue a single operation.
## TODO
-- Automatic sibling resolution for simple types
-- Ability to provide sibling resolution callback
+- Ability to provide custom sibling resolution callbacks
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)