README.rdoc in chimera-0.0.3 vs README.rdoc in chimera-0.0.4
- old
+ new
@@ -12,21 +12,27 @@
Internally, Chimera uses Redis for any indexes you define as well as some default indexes
that are automatically created. There's no built in sharding for Redis, but since it's
only being used for key storage and basic data elements you should be able to go a long
way with one Redis server (especially if you use the new Redis VM).
+!! Chimera is alpha. It's not production tested and needs a better test suite. !!
+!! It's also only tested in Ruby 1.9. !!
+
== FEATURES:
* Uses Riak (http://riak.basho.com/) for your primary storage.
* Uses Redis for indexes and also allows you to define Redis objects on a model.
* Supports unique and non-unique indexes, as well as basic search indexes (words are stemmed,
uses set intersection so you can get an AND/OR search).
* Supports a geospatial index type for simple storage and lookup of coordinates.
+* Uses Typhoeus for communicating with Riak.
+* Surfaces siblings from Riak so that conflicts can be managed and resolved.
== ISSUES/NOTES:
* Experimental. Not yet tested in production environment, use at your own risk.
+* Only tested with Ruby 1.9. Why not upgrade?
* Test coverage needs to be improved.
* Documentation is lacking. At the moment reading the tests and sample test/models.rb
file are your best bet.
== SYNOPSIS:
@@ -60,23 +66,25 @@
c.save
Car.find_with_index(:year, 2010)
=> [c]
- Car.find_with_index(:description, "rigid boat", :type => :union)
+ Car.find_with_index(:description, :q => "rigid boat", :type => :union)
=> [c]
- Car.find_with_index(:description, "rigid boat", :type => :intersect)
+ Car.find_with_index(:description, :q => "rigid boat", :type => :intersect)
=> []
* See tests for more usage examples
== REQUIREMENTS:
* Riak Server
* Redis Server
+* Ruby 1.9
+
* ActiveSupport+ActiveModel 3.0.0.beta
* uuidtools 2.1.1
* yajl-ruby 0.7.4
* fast-stemmer 1.0.0
@@ -87,16 +95,18 @@
$ gem install rails --pre
$ gem install chimera
== USEFUL LINKS:
-* http://groups.google.com/group/chimera-lib
+* Discussion: http://groups.google.com/group/chimera-lib
+* Email: ben dot myles at gmail dot com
+* Twitter: benmyles
== LICENSE:
(The MIT License)
-Copyright (c) 2010 FIXME full name
+Copyright (c) 2010 Ben Myles
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
\ No newline at end of file