From 28e2151cbb9cf5d19801fe5d222784f4c5fd88e6 Mon Sep 17 00:00:00 2001 From: Juan Carlos Garcia Date: Tue, 24 Oct 2023 13:22:02 +0200 Subject: [PATCH] fix: Updating README --- README.md | 15 +++++++++++---- lib/rollout/version.rb | 2 +- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3a1614f..3588b09 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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. @@ -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: diff --git a/lib/rollout/version.rb b/lib/rollout/version.rb index e7527ae..c8f05ab 100644 --- a/lib/rollout/version.rb +++ b/lib/rollout/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true class Rollout - VERSION = '0.3.0' + VERSION = '0.3.1' end \ No newline at end of file