Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jaymcaliley committed Mar 16, 2012
1 parent 383475d commit a9b532f
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Expand Up @@ -4,7 +4,14 @@ Togg implements feature toggle for Ruby on Rails applications. Martin Fowler has
http://martinfowler.com/bliki/FeatureToggle.html

## Usage ##
Simply create a YAML configuration file that lists your application features, then wrap your feature-specific code in blocks.

Include `togg` in the Gemfile for your Rails 3 application:

```ruby
gem 'togg'
```

To use `togg`, simply create a YAML configuration file that lists your application features, then wrap your feature-specific code in blocks.

## Example ##

Expand Down Expand Up @@ -40,4 +47,4 @@ Togg.le(:some_pending_feature) do
end
```

The features with keys that evaluate to `true` in your yaml file get executed, and the others don't
The features with keys that evaluate to `true` in your yaml file get executed, and the others don't.

0 comments on commit a9b532f

Please sign in to comment.