Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1.48 KB

README.md

File metadata and controls

38 lines (29 loc) · 1.48 KB
Raw

Shapt

A helpful and simple way to use feature toggles/flippers/flags on your Elixir code. This library heavily uses macros to achieve it's goals. Please read our usage guide.

This is library is currently a work in progress, it's api is not strongly defined, expect changes.

Name

Do what you want 'cause a pirate is free You are a pirate!

Yar har, fiddle de dee Being a pirate is alright to be Do what you want 'cause a pirate is free You are a pirate!

Features

This are the list of main features(marked ones are already implemented):

  • Configurable adapters that are simple to implement.
  • Shapt.Adapters.Env and Shapt.Adapters.DotEnv built-in Adapters.
  • shapt.expired mix task that exposes toggles that had his deadline expired.
  • shapt.template mix task that generate template files for the configured adapter.
  • Plug that provides a GET endpoint to inspect current state of the toggles.
  • Plug that provides a POST endpoint that reload toggles value(reload feature must be provided by the Adapter).
  • Consul Adapters

Usage Guide

Read our usage guide to understand how to start using this library.

Credits

This library is inspired by several ideas from Renan Ranelli.

Changelog

  • current version v0.0.1

Code of Conduct

License

Shapt is under Apache v2.0 license. Check the LICENSE file for more details.