README.md in streaker-1.0.0 vs README.md in streaker-1.1.0

- old
+ new

@@ -31,25 +31,28 @@ ```rb box = Streaker::Box.create( name: 'Some box name', stage: :my_stage, my_field: 'Some field value', + assigned_to: ['streak-owner@email.com', 'streak-contributor@email.com', …] … ) box.key # => your new box's key ``` Update a box: ```rb box = Streaker::Box.new('a_box_key') box.update( + name: 'my box name', + stage: :some_other_stage, my_field: 'A new field value', - … ) ``` + ## Configuration Configure Streaker: ```rb @@ -58,10 +61,11 @@ config.api_key = 'YOUR_API_KEY_HERE' # Provide an identifier for the pipeline(s) you want to access. # You can find the pipeline keys keys by configuring your api key, then typing # inside a console: + # # > Streak::Pipeline.all.map { |p| [p.key, p.name] }.to_h config.pipeline_keys = { default: 'YOUR_PIPELINE_KEY_HERE', } @@ -80,10 +84,9 @@ # Provide an identifier for each custom field your boxes can have. # You can find all the field keys by configuring a pipeline key, then typing # inside a console: # - # $ bin/console # > pipeline_key = Streaker.configuration.pipeline_keys.values.first # > box = Streak::Box.all(pipeline_key).first ; nil # > Streak::FieldValue.all(box.key) config.field_keys = { my_field: 1043,