README.md in cellect-server-1.3.3 vs README.md in cellect-server-2.0.0.beta1
- old
+ new
@@ -12,24 +12,30 @@
- [cellect-client](https://rubygems.org/gems/cellect-client)
- [cellect](https://rubygems.org/gems/cellect)(combined)
## Cellect::Server
-An actor based system that provides an API around subject selection actions. Server nodes are discovered via [ZooKeeper](http://zookeeper.apache.org/).
+An actor based system that provides an API around subject selection actions. Server nodes are discovered via [Attention](https://github.com/parrish/attention).
### Cellect::Server::Adapters
[An adapter](lib/cellect/server/adapters/default.rb) provides an API for defining the data to be used with the system.
We're overriding the default adapter with a customization in [cellect_panoptes](https://github.com/zooniverse/cellect_panoptes).
## Cellect::Client
-Provides a mix of asynchronous and synchronous operations for server awareness and API communication.
+Provides operations for server awareness and API communication.
+API timeouts can be set with
+```ruby
+ Cellect::Client::Connection.timeout = 5 # seconds
+```
+
+
## Building
1. Install [Boost V1.55+](http://www.boost.org/): OS X: `brew update && brew install boost`, Ubuntu: `sudo apt-get update && sudo apt-get install libboost-all-dev`
2. Install gem dependencies: `bundle` (See Note)
@@ -40,12 +46,10 @@
* rbenv: `CONFIGURE_OPTS="--enable-shared" rbenv install [version]`
## Testing
-* You'll need a local Zookeeper server to run the specs (they will auto start / stop the server for you).
- * `brew install zookeeper`
- * Note: this may require a Java Runtime (JRE) install, `brew cask install java`
+* You'll need a local Redis server to run the specs.
Run the specs with `rake`
## Start server: