Merge pull request #158 from mixonic/documentation

Clean up README files to be more clear and helpful
redis-store · Jan 18, 2013 · dd8d211 · dd8d211
2 parents d5cfa27 + 7ea89db
commit dd8d211
Show file tree

Hide file tree

Showing 9 changed files with 108 additions and 288 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,10 @@
+[![Build Status](https://secure.travis-ci.org/jodosha/redis-store.png?branch=master)](http://travis-ci.org/jodosha/redis-store?branch=master) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jodosha/redis-store)
+
 # Redis stores for Ruby frameworks
 
-__Redis Store__ provides a full set of stores (*Cache*, *I18n*, *Session*, *HTTP Cache*) for all the modern Ruby frameworks like: __Ruby on Rails__, __Sinatra__, __Rack__, __Rack::Cache__ and __I18n__. It natively supports object marshalling, timeouts, single or multiple nodes and namespaces.
+__Redis Store__ provides a full set of stores (*Cache*, *I18n*, *Session*, *HTTP Cache*) for modern Ruby frameworks like: __Ruby on Rails__, __Sinatra__, __Rack__, __Rack::Cache__ and __I18n__. It supports object marshalling, timeouts, single or multiple nodes, and namespaces.
 
-Please check the *README* file of each gem, to be informed about the usage.
+Please check the *README* file of each gem for usage and installation guidelines.
 
 ## Redis Installation
 
@@ -16,22 +18,18 @@ MacOS X users should use [Homebrew](https://github.com/mxcl/homebrew) to install
 
 Download and install Redis from [http://redis.io](http://redis.io/)
 
-	wget http://redis.googlecode.com/files/redis-2.4.15.tar.gz
+    wget http://redis.googlecode.com/files/redis-2.4.15.tar.gz
     tar -zxf redis-2.4.15.tar.gz
     mv redis-2.4.15 redis
     cd redis
     make
 
-## Code
-
-[![Build Status](https://secure.travis-ci.org/jodosha/redis-store.png?branch=master)](http://travis-ci.org/jodosha/redis-store?branch=master) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jodosha/redis-store)
-
 ## Running tests
 
     git clone git://github.com/jodosha/redis-store.git
-	cd redis-store
+	  cd redis-store
-	gem install bundler
+	  gem install bundler
-	ruby ci/run.rb
+	  ruby ci/run.rb
 
 If you are on **Snow Leopard** you have to run `env ARCHFLAGS="-arch x86_64" ruby ci/run.rb`
 

diff --git a/redis-actionpack/README.md b/redis-actionpack/README.md
@@ -1,60 +1,25 @@
 # Redis stores for ActionPack
 
-__`redis-actionpack`__ provides a full set of stores (*Session*, *HTTP Cache*) for __ActionPack__. It natively supports object marshalling, timeouts, single or multiple nodes and namespaces.
+__`redis-actionpack`__ provides a session store for __ActionPack__, specifically for __ActionDispatch__. See the main [redis-store readme](https://github.com/jodosha/redis-store) for general guidelines.
 
-## Redis Installation
+## Installation
-
-### Option 1: Homebrew
-
-MacOS X users should use [Homebrew](https://github.com/mxcl/homebrew) to install Redis:
-
-    brew install redis
-
-### Option 2: From Source
-
-Download and install Redis from [http://redis.io](http://redis.io/)
-
-	wget http://redis.googlecode.com/files/redis-2.4.15.tar.gz
-    tar -zxf redis-2.4.15.tar.gz
-    mv redis-2.4.15 redis
-    cd redis
-    make
-
-## Usage
 
     # Gemfile
-	gem 'redis-actionpack'
+    gem 'redis-actionpack'
-
-### Session Store: Ruby on Rails
-
-    # config/initializers/session_store.rb
-	MyApplication::Application.config.session_store :redis_store
-
-### Session Store: Standalone
-
-	ActionController::Base.cache_store = ActionDispatch::Session::RedisSessionStore.new
-
-### HTTP Cache
-
-    # config.ru
-	require 'rack'
-	require 'rack/cache'
-	require 'redis-rack-cache'
 
-	use Rack::Cache,
+### Usage
-	  :metastore   => 'redis://localhost:6379/0/metastore',
-	  :entitystore => 'redis://localhost:6380/0/entitystore'
 
-#### Configuration
+If you are using redis-store with Rails, consider using the [redis-rails gem](https://github.com/jodosha/redis-store/tree/master/redis-rails) instead. For standalone usage:
 
-For advanced configuration options, please check the [Redis Store Wiki](https://github.com/jodosha/redis-store/wiki).
+    ActionController::Base.cache_store = ActionDispatch::Session::RedisSessionStore.new
 
 ## Running tests
 
+    gem install bundler
     git clone git://github.com/jodosha/redis-store.git
-	cd redis-store/redis-actionpack
+    cd redis-store/redis-actionpack
-	gem install bundler
+    bundle install
-	bundle exec rake
+    bundle exec rake
 
 If you are on **Snow Leopard** you have to run `env ARCHFLAGS="-arch x86_64" bundle exec rake`
 

diff --git a/redis-activesupport/README.md b/redis-activesupport/README.md
@@ -1,49 +1,25 @@
 # Redis stores for ActiveSupport
 
-__`redis-activesupport`__ provides a full set of stores (*Cache*) for __ActiveSupport__. It natively supports object marshalling, timeouts, single or multiple nodes and namespaces.
+__`redis-activesupport`__ provides a cache for __ActiveSupport__. See the main [redis-store readme](https://github.com/jodosha/redis-store) for general guidelines.
 
-## Redis Installation
+## Installation
-
-### Option 1: Homebrew
-
-MacOS X users should use [Homebrew](https://github.com/mxcl/homebrew) to install Redis:
-
-    brew install redis
-
-### Option 2: From Source
-
-Download and install Redis from [http://redis.io](http://redis.io/)
-
-	wget http://redis.googlecode.com/files/redis-2.4.15.tar.gz
-    tar -zxf redis-2.4.15.tar.gz
-    mv redis-2.4.15 redis
-    cd redis
-    make
-
-## Usage
 
     # Gemfile
-	gem 'redis-activesupport'
+    gem 'redis-activesupport'
-
-### Cache Store: Ruby on Rails
-
-    # config/environments/production.rb
-	config.cache_store = :redis_store # { ... optional configuration ... }
-
-### Cache Store: Standalone
 
-	ActiveSupport::Cache.lookup_store :redis_store # { ... optional configuration ... }
+### Usage
 
-#### Configuration
+If you are using redis-store with Rails, consider using the [redis-rails gem](https://github.com/jodosha/redis-store/tree/master/redis-rails) instead. For standalone usage:
 
-For advanced configuration options, please check the [Redis Store Wiki](https://github.com/jodosha/redis-store/wiki).
+    ActiveSupport::Cache.lookup_store :redis_store # { ... optional configuration ... }
 
 ## Running tests
 
+    gem install bundler
     git clone git://github.com/jodosha/redis-store.git
-	cd redis-store/redis-activesupport
+    cd redis-store/redis-activesupport
-	gem install bundler
+    bundle install
-	bundle exec rake
+    bundle exec rake
 
 If you are on **Snow Leopard** you have to run `env ARCHFLAGS="-arch x86_64" bundle exec rake`
 

diff --git a/redis-i18n/README.md b/redis-i18n/README.md
@@ -1,44 +1,25 @@
 # Redis stores for I18n
 
-__`redis-i18n`__ provides a Redis backend for __I18n__. It natively supports object marshalling, timeouts, single or multiple nodes and namespaces.
+__`redis-i18n`__ provides a Redis backend for __I18n__. See the main [redis-store readme](https://github.com/jodosha/redis-store) for general guidelines.
 
-## Redis Installation
+## Installation
-
-### Option 1: Homebrew
-
-MacOS X users should use [Homebrew](https://github.com/mxcl/homebrew) to install Redis:
-
-    brew install redis
-
-### Option 2: From Source
-
-Download and install Redis from [http://redis.io](http://redis.io/)
-
-	wget http://redis.googlecode.com/files/redis-2.4.15.tar.gz
-    tar -zxf redis-2.4.15.tar.gz
-    mv redis-2.4.15 redis
-    cd redis
-    make
-
-## Usage
 
     # Gemfile
-	gem 'redis-i18n'
+    gem 'redis-i18n'
-
-### Backend:
 
-	I18n.backend = I18n::Backend::Redis.new
+### Usage
 
-#### Configuration
+If you are using redis-store with Rails, consider using the [redis-rails gem](https://github.com/jodosha/redis-store/tree/master/redis-rails) instead. For standalone usage:
 
-For advanced configuration options, please check the [Redis Store Wiki](https://github.com/jodosha/redis-store/wiki).
+    I18n.backend = I18n::Backend::Redis.new
 
 ## Running tests
 
+    gem install bundler
     git clone git://github.com/jodosha/redis-store.git
-	cd redis-store/redis-i18n
+    cd redis-store/redis-i18n
-	gem install bundler
+    bundle install
-	bundle exec rake
+    bundle exec rake
 
 If you are on **Snow Leopard** you have to run `env ARCHFLAGS="-arch x86_64" bundle exec rake`
 

diff --git a/redis-rack-cache/README.md b/redis-rack-cache/README.md
@@ -1,51 +1,32 @@
 # Redis stores for Rack::Cache
 
-__`redis-rack-cache`__ provides a Redis backed store for __Rack::Cache__. It natively supports object marshalling, timeouts, single or multiple nodes and namespaces.
+__`redis-rack-cache`__ provides a Redis backed store for __Rack::Cache__, an HTTP cache. See the main [redis-store readme](https://github.com/jodosha/redis-store) for general guidelines.
 
-## Redis Installation
+## Installation
-
-### Option 1: Homebrew
-
-MacOS X users should use [Homebrew](https://github.com/mxcl/homebrew) to install Redis:
-
-    brew install redis
-
-### Option 2: From Source
-
-Download and install Redis from [http://redis.io](http://redis.io/)
-
-	wget http://redis.googlecode.com/files/redis-2.4.15.tar.gz
-    tar -zxf redis-2.4.15.tar.gz
-    mv redis-2.4.15 redis
-    cd redis
-    make
-
-## Usage
 
     # Gemfile
-	gem 'redis-rack-cache'
+    gem 'redis-rack-cache'
 
-### HTTP Cache Store:
+### Usage
 
-    # config.ru
+If you are using redis-store with Rails, consider using the [redis-rails gem](https://github.com/jodosha/redis-store/tree/master/redis-rails) instead. For standalone usage:
-	require 'rack'
-	require 'rack/cache'
-	require 'redis-rack-cache'
 
-	use Rack::Cache,
+    # config.ru
-	  :metastore   => 'redis://localhost:6379/0/metastore',
+    require 'rack'
-	  :entitystore => 'redis://localhost:6380/0/entitystore'
+    require 'rack/cache'
-
+    require 'redis-rack-cache'
-#### Configuration
 
-For advanced configuration options, please check the [Redis Store Wiki](https://github.com/jodosha/redis-store/wiki).
+    use Rack::Cache,
+      metastore: 'redis://localhost:6379/0/metastore',
+      entitystore: 'redis://localhost:6380/0/entitystore'
 
 ## Running tests
 
+    gem install bundler
     git clone git://github.com/jodosha/redis-store.git
-	cd redis-store/redis-rack-cache
+    cd redis-store/redis-rack-cache
-	gem install bundler
+    bundle install
-	bundle exec rake
+    bundle exec rake
 
 If you are on **Snow Leopard** you have to run `env ARCHFLAGS="-arch x86_64" bundle exec rake`
 

diff --git a/redis-rack/README.md b/redis-rack/README.md
@@ -1,48 +1,29 @@
 # Redis stores for Rack
 
-__`redis-rack`__ provides a Redis backed session store __Rack__. It natively supports object marshalling, timeouts, single or multiple nodes and namespaces.
+__`redis-rack`__ provides a Redis backed session store __Rack__. See the main [redis-store readme](https://github.com/jodosha/redis-store) for general guidelines.
 
-## Redis Installation
+## Installation
-
-### Option 1: Homebrew
-
-MacOS X users should use [Homebrew](https://github.com/mxcl/homebrew) to install Redis:
-
-    brew install redis
-
-### Option 2: From Source
-
-Download and install Redis from [http://redis.io](http://redis.io/)
-
-	wget http://redis.googlecode.com/files/redis-2.4.15.tar.gz
-    tar -zxf redis-2.4.15.tar.gz
-    mv redis-2.4.15 redis
-    cd redis
-    make
-
-## Usage
 
     # Gemfile
-	gem 'redis-rack'
+    gem 'redis-rack'
 
-### Session Store:
+### Usage
 
-    # config.ru
+If you are using redis-store with Rails, consider using the [redis-rails gem](https://github.com/jodosha/redis-store/tree/master/redis-rails) instead. For standalone usage:
-	require 'rack'
-	require 'rack/session/redis'
 
-	use Rack::Session::Redis
+    # config.ru
-
+    require 'rack'
-#### Configuration
+    require 'rack/session/redis'
 
-For advanced configuration options, please check the [Redis Store Wiki](https://github.com/jodosha/redis-store/wiki).
+    use Rack::Session::Redis
 
 ## Running tests
 
+    gem install bundler
     git clone git://github.com/jodosha/redis-store.git
-	cd redis-store/redis-rack
+    cd redis-store/redis-rack
-	gem install bundler
+    bundle install
-	bundle exec rake
+    bundle exec rake
 
 If you are on **Snow Leopard** you have to run `env ARCHFLAGS="-arch x86_64" bundle exec rake`