README.md in muffin_man-0.2.0 vs README.md in muffin_man-1.0.0
- old
+ new
@@ -1,11 +1,17 @@
# MuffinMan
+![Ruby CI](https://github.com/patterninc/muffin_man/actions/workflows/ci.yml/badge.svg)
+
MuffinMan is a ruby interface to the Amazon Selling Partner API. For more information on registering to use the Selling Partner API, see [Amazon's documentation](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/developer-guide/SellingPartnerApiDeveloperGuide.md)
-As of now, this gem only supports the `create_product_review_and_seller_feedback_solicitation` model, likely with more to come.
+As of now, this gem only supports portions of the following APIs with more to come:
+- `create_product_review_and_seller_feedback_solicitation`
+- `catalog_items`
+- `reports`
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -33,10 +39,10 @@
aws_access_key_id: AWS_ACCESS_KEY_ID,
aws_secret_access_key: AWS_SECRET_ACCESS_KEY,
region: REGION, # This can be one of ['na', 'eu', 'fe'] and defaults to 'na'
sts_iam_role_arn: STS_IAM_ROLE_ARN, # Optional
}
-client = MuffinMan::Solicitations.new(credentials)
+client = MuffinMan::Solicitations::V1.new(credentials)
response = client.create_product_review_and_seller_feedback_solicitation(amazon_order_id, marketplace_ids)
JSON.parse(response.body)
```
You can optionally use Amazon's sandbox environment by specifying `client = MuffinMan::Solicitations.new(credentials, sandbox = true)`