docs/read-only/README.md in flipper-0.21.0.rc1 vs docs/read-only/README.md in flipper-0.21.0.rc2
- old
+ new
@@ -3,19 +3,22 @@
A [read-only](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/read_only.rb) adapter for [Flipper](https://github.com/jnunemaker/flipper).
Use this adapter to wrap another adapter and raise an exception for any writes.
Any attempted write raises `Flipper::Adapters::ReadOnly::WriteAttempted` with message `'write attempted while in read only mode'`
+
## Usage
+
```ruby
# example wrapping memory adapter
require 'flipper/adapters/read_only'
-memory_adapter = Flipper::Adapters::Memory.new
-read_only_adapter = Flipper::Adapters::ReadOnly.new(memory_adapter)
+Flipper.configure do |config|
+ config.adapter do
+ Flipper::Adapters::ReadOnly.new(Flipper::Adapters::Memory.new)
+ end
+end
-flipper = Flipper.new(read_only_adapter)
-
# Enabling a feature
-> flipper[:dashboard_panel].enable
+> Flipper[:dashboard_panel].enable
=> Flipper::Adapters::ReadOnly::WriteAttempted: write attempted while in read only mode
```