README.mdown in split-0.2.1 vs README.mdown in split-0.2.2

- old
+ new

@@ -6,10 +6,12 @@ ## Requirements Split uses redis as a datastore. +Split only supports redis 2.0 or greater. + If you're on OS X, Homebrew is the simplest way to install Redis: $ brew install redis $ redis-server /usr/local/etc/redis.conf @@ -31,10 +33,18 @@ and require it in your project: require 'split' +### SystemTimer + +If you are using Redis on Ruby 1.8.x then you will likely want to also use the SystemTimer gem if you want to make sure the Redis client will not hang. + +Put the following in your gemfile as well: + + gem 'SystemTimer' + ### Rails Split is autoloaded when rails starts up, as long as you've configured redis it will 'just work'. ### Sinatra @@ -112,10 +122,19 @@ username == 'admin' && password == 'p4s5w0rd' end ## Configuration +You can override the default configuration options of Split like so: + + Split.configure do |config| + config.robot_regex = /my_custom_robot_regex/ + config.ignore_ip_addresses << '81.19.48.130' + end + +### Redis + You may want to change the Redis host and port Split connects to, or set various other options at startup. Split has a `redis` setter which can be given a string or a Redis object. This means if you're already using Redis in your app, Split @@ -155,11 +174,11 @@ Split uses by default to separate the keys it manages from other keys in your Redis server. Simply use the `Split.redis.namespace` accessor: - Split.redis.namespace = "resque:GitHub" + Split.redis.namespace = "split:blog" We recommend sticking this in your initializer somewhere after Redis is configured. ## Contributors @@ -167,10 +186,17 @@ Special thanks to the following people for submitting patches: * Lloyd Pick * Jeffery Chupp -## Note on Patches/Pull Requests +## Development + +Source hosted at [GitHub](http://github.com/andrew/split). +Report Issues/Feature requests on [GitHub Issues](http://github.com/andrew/split/issues). + +Tests can be ran with `rake spec` + +### Note on Patches/Pull Requests * Fork the project. * Make your feature addition or bug fix. * Add tests for it. This is important so I don't break it in a future version unintentionally. \ No newline at end of file