README.md in coinbase_commerce_client-0.1.0 vs README.md in coinbase_commerce_client-0.2.0
- old
+ new
@@ -2,11 +2,11 @@
<p>
<img width="100%" src="https://raw.githubusercontent.com/viniciusborgeis/coinbase_commerce_client/main/assets/banner.png" alt="Solid Vite Templates">
</p>
# Coinbase Commerce Client
-> <sub>This gem is completely inspired by official Coinbase gem [coinbase-commerce-ruby](coinbase-commerce-ruby), unfortunately the oficial gem actually is deprecated, and my motivation is to continue support for this gem</sub>
+> <sub>This gem is completely inspired by official Coinbase gem [coinbase-commerce-ruby](https://github.com/coinbase/coinbase-commerce-ruby), unfortunately the oficial gem actually is deprecated, and my motivation is to continue support for this gem</sub>
Coinbase Commerce Client Ruby Gem
# Table of contents
@@ -104,11 +104,11 @@
gem install coinbase_commerce_client
```
## Usage
```ruby
-require 'coinbase_commerce'
+require 'coinbase_commerce_client'
client = CoinbaseCommerceClient::Client.new(api_key: 'your_api_key')
```
## Checkouts
[Checkouts API docs](https://commerce.coinbase.com/docs/api/#checkouts)
### Retrieve
@@ -196,10 +196,16 @@
```
### List
```ruby
charges_list = client.charge.list
```
+### Cancel
+```ruby
+charge = client.charge.retrieve <charge_id>
+
+charge.cancel
+```
### Paging list iterations
```ruby
client.charge.auto_paging do |charge|
puts charge.id
end
@@ -257,10 +263,10 @@
### Testing and Contributing
Any and all contributions are welcome! The process is simple: fork this repo, make your changes, add tests, run the test suite, and submit a pull request. Tests are run via rspec. To run the tests, clone the repository and then:
# Install the requirements
- gem install coinbase_commerce
+ gem install coinbase_commerce_client
rspec spec
# or via Bundle
bundle install
bundle exec rspec spec
\ No newline at end of file