Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up README files to be more clear and helpful #158

Merged
merged 1 commit into from Jan 18, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 8 additions & 10 deletions 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

Expand All @@ -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
gem install bundler
ruby ci/run.rb
cd redis-store
gem install bundler
ruby ci/run.rb

If you are on **Snow Leopard** you have to run `env ARCHFLAGS="-arch x86_64" ruby ci/run.rb`

Expand Down
55 changes: 10 additions & 45 deletions 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

### 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
## Installation

# Gemfile
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'
gem 'redis-actionpack'

use Rack::Cache,
:metastore => 'redis://localhost:6379/0/metastore',
:entitystore => 'redis://localhost:6380/0/entitystore'
### 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).
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
gem install bundler
bundle exec rake
cd redis-store/redis-actionpack
bundle install
bundle exec rake

If you are on **Snow Leopard** you have to run `env ARCHFLAGS="-arch x86_64" bundle exec rake`

Expand Down
44 changes: 10 additions & 34 deletions 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

### 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
## Installation

# Gemfile
gem 'redis-activesupport'

### Cache Store: Ruby on Rails

# config/environments/production.rb
config.cache_store = :redis_store # { ... optional configuration ... }

### Cache Store: Standalone
gem 'redis-activesupport'

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
gem install bundler
bundle exec rake
cd redis-store/redis-activesupport
bundle install
bundle exec rake

If you are on **Snow Leopard** you have to run `env ARCHFLAGS="-arch x86_64" bundle exec rake`

Expand Down
39 changes: 10 additions & 29 deletions 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

### 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
## Installation

# Gemfile
gem 'redis-i18n'

### Backend:
gem 'redis-i18n'

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
gem install bundler
bundle exec rake
cd redis-store/redis-i18n
bundle install
bundle exec rake

If you are on **Snow Leopard** you have to run `env ARCHFLAGS="-arch x86_64" bundle exec rake`

Expand Down
51 changes: 16 additions & 35 deletions 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

### 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
## Installation

# Gemfile
gem 'redis-rack-cache'
gem 'redis-rack-cache'

### HTTP Cache Store:
### Usage

# config.ru
require 'rack'
require 'rack/cache'
require 'redis-rack-cache'
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:

use Rack::Cache,
:metastore => 'redis://localhost:6379/0/metastore',
:entitystore => 'redis://localhost:6380/0/entitystore'

#### Configuration
# config.ru
require 'rack'
require 'rack/cache'
require 'redis-rack-cache'

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
gem install bundler
bundle exec rake
cd redis-store/redis-rack-cache
bundle install
bundle exec rake

If you are on **Snow Leopard** you have to run `env ARCHFLAGS="-arch x86_64" bundle exec rake`

Expand Down
45 changes: 13 additions & 32 deletions 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

### 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
## Installation

# Gemfile
gem 'redis-rack'
gem 'redis-rack'

### Session Store:
### Usage

# config.ru
require 'rack'
require 'rack/session/redis'
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:

use Rack::Session::Redis

#### Configuration
# config.ru
require 'rack'
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
gem install bundler
bundle exec rake
cd redis-store/redis-rack
bundle install
bundle exec rake

If you are on **Snow Leopard** you have to run `env ARCHFLAGS="-arch x86_64" bundle exec rake`

Expand Down