README.md in speed_lightning-0.1.1 vs README.md in speed_lightning-0.2.0

- old
+ new

@@ -20,11 +20,11 @@ $ gem install speed_lightning ## Usage -Find full documentation of this gem and more examples under documentation.rb +Find full documentation of this gem and more examples: [Detailed Documentation](DOCUMENTATION.md) Optionally, if you are testing this gem without installing in IRB ``` irb require './lib/speed_lightning' @@ -34,30 +34,30 @@ `require 'speed_lightning'` Initialize the library with Speed test environment secret key -`client = SpeedLightning::Client.new("your_speed_secret_key_here")` +`client = SpeedLightning::Client.new(secret_key: "your_speed_secret_key_here")` -create a new checkout link with required parameters: invoice amount, success return url +create a new checkout link with required parameters in test mode: invoice amount, success return url -`response = client.create_speed_checkout_link(777, "https://yourwebsite.com/thank_you")` +`response = client.create_checkout_link(777, "https://your_website.com/thank_you")` get speed checkout url with QR code and LN invoice: -`puts response["url"]` +`puts response.url` get speed checkout ID: -`puts response["id"]` +`puts checkout_id = response.id` get invoice status -`response = client.retrieve_speed_checkout_link(checkout_id)` +`response = client.retrieve_checkout_link(checkout_id)` get payment status -`puts response["status"]` +`puts response.status` ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. \ No newline at end of file