Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 1.11 KB

README.md

File metadata and controls

47 lines (32 loc) · 1.11 KB
Raw

Flipper Consul

A Consul adapter for Flipper.

Uses Diplomat as the Consul client.

Installation

Add this line to your application's Gemfile:

gem 'flipper-consul'

And then execute:

$ bundle

Or install it yourself with:

$ gem install flipper-consul

Usage

require 'flipper/adapters/consul'
client = Diplomat::Kv.new
adapter = Flipper::Adapters::Consul.new(client)
flipper = Flipper.new(adapter)

To avoid polluting the global key/value space, the Flipper data can (and should) be namespaced.

require 'flipper/adapters/consul'
client = Diplomat::Kv.new
adapter = Flipper::Adapters::Consul.new(client, 'your/flipper/namespace')
flipper = Flipper.new(adapter)

Contributing

  1. Fork it ( https://github.com/[my-github-username]/flipper-consul/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request