README.md in helio-ruby-0.1.0 vs README.md in helio-ruby-0.2.0

- old
+ new

@@ -1,17 +1,20 @@ # Helio Ruby Library +### THIS GEM IS NOT PRODUCTION READY +The first production release will be version 1.0.0. Until then, consider this gem unstable as the Helio API is in flux. + ## Installation You don't need this source code unless you want to modify the gem. If you just want to use the package, just run: - gem install helio + gem install helio-ruby If you want to build the gem from source: - gem build helio.gemspec + gem build helio-ruby.gemspec ### Requirements * Ruby 2.0+. @@ -23,27 +26,28 @@ ``` ruby source 'https://rubygems.org' gem 'rails' -gem 'helio' +gem 'helio-ruby' ``` ## Usage The library needs to be configured with your account's secret key which is available in your [Helio Dashboard][api-keys]. Set `Helio.api_token` to its value: ``` ruby require "helio" +Helio.api_id = "..." Helio.api_token = "..." -# list charges +# list participants Helio::Participant.list() -# retrieve single charge +# retrieve single participant Helio::Participant.retrieve( "id", ) ``` @@ -54,18 +58,18 @@ ``` ruby require "helio" Helio::Participant.list( {}, - :api_token => "sk_test_...", - :api_id => "acct_..." + :api_token => "...", + :api_id => "..." ) Helio::Participant.retrieve( "id", - :api_token => "token...", - :api_id => "acct_..." + :api_token => "...", + :api_id => "..." ) ``` ### Configuring a Client @@ -74,11 +78,11 @@ `Helio::HelioClient` object and giving it a connection: ``` ruby conn = Faraday.new client = Helio::HelioClient.new(conn) -charge, resp = client.request do - Helio::participant.retrieve( +participant, resp = client.request do + Helio::Participant.retrieve( "id", ) end puts resp.request_id ```