README.md in flux_capacitor-0.1.0 vs README.md in flux_capacitor-0.1.1
- old
+ new
@@ -1,11 +1,11 @@
+[](https://badge.fury.io/rb/flux_capacitor)
+
# FluxCapacitor
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/flux_capacitor`. To experiment with that code, run `bin/console` for an interactive prompt.
+Sometimes you want to change a feature or deploy a new feature but doing so all at once might take down some service. Enter Flux Capacitor. It allows you to gradually include more historical content in the new feature while allowing all future content to start out with the new feature already live.
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -23,12 +23,14 @@
## Usage
```ruby
require 'flux_capacitor'
-pivot = DateTime.parse('2017/08/14 00:00:00-000') # Everything after this date will have the new feature. This is the point in time when your new feature will start to go live
-oldest = MyModel.first.created_at # If you are using active record finding your oldest item is pretty easy, otherwise if you know the date of your first item, just use that
-end_point = DateTime.parse('2017/09/14') # At this point the feature should be fully rolled out and it is safe to remove the Flux Capacitor. This dictates how quickly the feature rolls out. If you are concerned about overloading a required service set this to farther in the future to lower load
+pivot = DateTime.parse('2017/08/14 00:00:00-000') # when do you want to start rolling out the feature
+oldest = MyModel.first.created_at # If you are using active record finding your oldest item is pretty easy
+# otherwise if you know the date of your first item, just use that
+end_point = DateTime.parse('2017/09/14') # The point where the feature is fully rolled out/safe to remove the Flux Capacitor.
+# This dictates how quickly the feature rolls out. If you are concerned about overloading a required service set this to farther in the future
FEATURE_1_CAPACITOR = Flux::Capacitor.new(pivot, end_point, oldest)
def controller_method
model = MyModel.find(params[:id])