README.md in paddle-1.1.0 vs README.md in paddle-1.1.1
- old
+ new
@@ -1,17 +1,15 @@
-# PaddleRB
+# Paddle Ruby Library
-PaddleRB is a Ruby library for interacting with the Paddle APIs, both Classic and Billing.
+A Ruby library for the Paddle APIs, both Classic and Billing.
-**This library is currently under development for Paddle's new Billing APIs**
-
## Installation
Add this line to your application's Gemfile:
```ruby
-gem "paddlerb"
+gem "paddle"
```
## Billing API
For accessing the new Billing API from Paddle. For more info, view the [Paddle Billing](https://www.paddle.com/billing) page.
@@ -76,10 +74,21 @@
# Update a price
# https://developer.paddle.com/api-reference/prices/update-price
Paddle::Price.update(id: "pri_123abc", description: "An updated description")
```
+### Pricing Preview
+
+```ruby
+# Preview calculations for one or more prices
+# This is normally used when building pricing pages
+# https://developer.paddle.com/api-reference/pricing-preview/preview-prices
+Paddle::PricingPreview.generate(items: [ { price_id: "pri_123abc", quantity: 5 } ])
+Paddle::PricingPreview.generate(items: [ { price_id: "pri_123abc", quantity: 5 } ], currency_code: "GBP")
+Paddle::PricingPreview.generate(items: [ { price_id: "pri_123abc", quantity: 5 } ], customer_ip_address: "1.1.1.1")
+```
+
### Discounts
```ruby
# List all discounts
# https://developer.paddle.com/api-reference/discounts/list-discounts
@@ -180,17 +189,10 @@
# Preview a transaction
# https://developer.paddle.com/api-reference/transaction/preview-transaction
Paddle::Transaction.preview(items: [ { price_id: "pri_123abc", quantity: 5 } ])
-# Preview calculations for one or more prices
-# This is normally used when building pricing pages
-# https://developer.paddle.com/api-reference/transaction/preview-prices
-Paddle::Transaction.preview_prices(items: [ { price_id: "pri_123abc", quantity: 5 } ])
-Paddle::Transaction.preview_prices(items: [ { price_id: "pri_123abc", quantity: 5 } ], currency_code: "GBP")
-Paddle::Transaction.preview_prices(items: [ { price_id: "pri_123abc", quantity: 5 } ], customer_ip_address: "1.1.1.1")
-
# Get a PDF invoice for a transaction
# Returns a raw URL. This URL is not permanent and will expire.
# https://developer.paddle.com/api-reference/transaction/get-invoice-pdf
Paddle::Transaction.invoice(id: "txn_abc123")
#=> https://paddle-sandbox-invoice...
@@ -393,10 +395,10 @@
@client.users.cancel(subscription_id: "abc123")
```
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/paddlerb.
+Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/paddle.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).