Skip to content

Commit

Permalink
Merge pull request #7 from jcagarcia/readme
Browse files Browse the repository at this point in the history
fix: Updating README
  • Loading branch information
jcagarcia committed Oct 24, 2023
2 parents bd7aa45 + 28e2151 commit ed88596
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ Based on the discontinued [rollout](https://github.com/fetlife/rollout) project,
Topics covered in this README:

- [Install it](#install-it)
- [Quick Start](#quick-start-💨)
- [Advanced features](#advanced-features-🦾)
- [Quick Start](#quick-start-)
- [Advanced features](#advanced-features-)
- [Gradual activation based on percentages](#gradual-activation-based-on-percentages)
- [Caching Feature Flags](#caching-feature-flags)
- [Auto-deactivating flags](#auto-deactivating-flags)
- [Rake tasks](#rake-tasks)
- [Migrating from rollout gem](#migrating-from-rollout-gem-🚨)
- [Migrating from rollout gem](#migrating-from-rollout-gem-)
- [Changelog](#changelog)
- [Contributing](#contributing)

Expand Down Expand Up @@ -147,7 +147,7 @@ If you want to allow the gem to deactivate your feature flag automatically when
```ruby
@rollout ||= Rollout.new(redis)
.with_cache
.with_degrade(sample: 5000, min: 100, threshold: 0.1)
.with_degrade(min: 100, threshold: 0.1)
```

So now, instead of using the `active?` method, you need to wrap your new code under the `with_feature` method.
Expand All @@ -170,6 +170,13 @@ require 'rollout'
load 'rollout/tasks/rollout.rake'
```

Also, for using the rake tasks, you must set the following env variables

```shell
ROLLOUT_REDIS_HOST=localhost
ROLLOUT_REDIS_PORT=6379
```

### Usage

To activate/deactivate features, execute the following rake tasks:
Expand Down
2 changes: 1 addition & 1 deletion lib/rollout/version.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

class Rollout
VERSION = '0.3.0'
VERSION = '0.3.1'
end

0 comments on commit ed88596

Please sign in to comment.