From 26ae48afab632a942b5421c9205821edb1b6d3cd Mon Sep 17 00:00:00 2001 From: Colm Doyle Date: Thu, 29 Sep 2016 13:07:55 +0100 Subject: [PATCH] Rename toggle? to variation Per https://github.com/launchdarkly/ruby-client/blob/master/lib/ldclient-rb/ldclient.rb#L59, the preferred way to test a feature flag is to use `variation(key, user, default)`, not `toggle?(key, user, default)` --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 04ff68aa..cf5c5139 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ Rails.configuration.ld_client = LaunchDarkly::LDClient.new("your_sdk_key") 3. In your controllers, access the client using ```ruby -Rails.application.config.ld_client.toggle?('your.flag.key', launchdarkly_settings, false) +Rails.application.config.ld_client.variation('your.flag.key', launchdarkly_settings, false) ``` Note that this gem will automatically switch to using the Rails logger it is detected. @@ -83,7 +83,7 @@ Your first feature flag 2. In your application code, use the feature's key to check whether the flag is on for each user: ```ruby -if client.toggle?("your.flag.key", {key: "user@test.com"}, false) +if client.variation("your.flag.key", {key: "user@test.com"}, false) # application code to show the feature else # the code to run if the feature is off