README.md in redis-store-1.0.0.beta2 vs README.md in redis-store-1.0.0.beta3
- old
+ new
@@ -1,21 +1,44 @@
-# Rack::Session, Rack::Cache and cache Redis stores for Ruby web frameworks
+# Namespaced Rack::Session, Rack::Cache, I18n and cache Redis stores for Ruby web frameworks
## Installation
Download and install Redis from [http://code.google.com/p/redis/](http://code.google.com/p/redis/)
- wget http://redis.googlecode.com/files/redis-2.0.0-rc1.tar.gz
- tar -zxf redis-2.0.0-rc1.tar.gz
- mv redis-2.0.0-rc1 redis
+ wget http://redis.googlecode.com/files/redis-2.0.0.tar.gz
+ tar -zxf redis-2.0.0.tar.gz
+ mv redis-2.0.0 redis
cd redis
make
Install the gem
sudo gem install redis-store
+## Options
+There are two ways to configure the Redis server options: by an URI string and by an hash.
+By default each store try to connect on `localhost` with the port `6379` and the db `0`.
+
+### String
+
+ "redis://:secret@192.168.1.100:23682/13/theplaylist"
+
+ host: 192.168.1.100
+ port: 23682
+ db: 13
+ namespace: theplaylist
+ password: secret
+
+If you want to specify the `namespace` optional, you have to pass the `db` param too.
+#### __Important__: for now (beta3) `namespace` is only supported for single, non-distributed stores.
+
+### Hash
+
+ { :host => 192.168.1.100, :port => 23682, :db => 13, :namespace => "theplaylist", :password => "secret" }
+
+#### __Important__: for now (beta3) `namespace` is only supported for single, non-distributed stores.
+
## Cache store
Provides a cache store for your Ruby web framework of choice.
### Rails 2.x
@@ -24,20 +47,22 @@
config.cache_store = :redis_store
### Rails 3.x
# Gemfile
- gem 'rails', '3.0.0.beta4'
+ gem 'rails', '3.0.0'
gem 'redis'
- gem 'redis-store', '1.0.0.beta2'
+ gem 'redis-store', '1.0.0.beta3'
# config/environments/production.rb
config.cache_store = :redis_store
+For advanced configurations scenarios please visit [the wiki](http://wiki.github.com/jodosha/redis-store/rails).
+
### Merb
- dependency "redis-store", "1.0.0.beta2"
+ dependency "redis-store", "1.0.0.beta3"
dependency("merb-cache", merb_gems_version) do
Merb::Cache.setup do
register(:redis, Merb::Cache::RedisStore, :servers => ["127.0.0.1:6379"])
end
end
@@ -71,20 +96,22 @@
ActionController::Base.session_store = :redis_session_store
### Rails 3.x
# Gemfile
- gem 'rails', '3.0.0.beta4'
+ gem 'rails', '3.0.0'
gem 'redis'
- gem 'redis-store', '1.0.0.beta2'
+ gem 'redis-store', '1.0.0.beta3'
# config/initializers/session_store.rb
- Rails.application.config.session_store :redis_session_store
+ MyApp::Application.config.session_store :redis_session_store
+For advanced configurations scenarios please visit [the wiki](http://wiki.github.com/jodosha/redis-store/rails).
+
### Merb
- dependency "redis-store", "1.0.0.beta2"
+ dependency "redis-store", "1.0.0.beta3"
Merb::Config.use do |c|
c[:session_store] = "redis"
end
Merb::BootLoader.before_app_loads do
Merb::SessionContainer.subclasses << "Merb::RedisSession"
@@ -115,22 +142,30 @@
use Rack::Cache,
:metastore => 'redis://localhost:6379/0',
:entitystore => 'redis://localhost:6380/1'
run Application.new
+## I18n
+
+ require "i18n"
+ require "redis-store"
+ I18n.backend = I18n::Backend::Redis.new
+
+The backend accepts the uri string and hash options.
+
## Running specs
gem install jeweler bundler
git clone git://github.com/jodosha/redis-store.git
cd redis-store
bundle install
- REDIS_STORE_ENV=rails3 bundle install # to install Rails 3.x gems
+ REDIS_STORE_ENV=rails3 bundle install # to install Rails 3 gems
rake dtach:install
rake redis:install
rake
- REDIS_STORE_ENV=rails3 rake # to test against Rails 3.x
+ REDIS_STORE_ENV=rails3 rake # to test against Rails 3
If you are on **Snow Leopard** you have to run `env ARCHFLAGS="-arch x86_64" bundle install`
## Copyright
-(c) 2010 Luca Guidi - [http://lucaguidi.com](http://lucaguidi.com), released under the MIT license
+(c) 2009 - 2010 Luca Guidi - [http://lucaguidi.com](http://lucaguidi.com), released under the MIT license