README.md in peddler-0.7.7 vs README.md in peddler-0.7.8
- old
+ new
@@ -1,43 +1,48 @@
# Peddler
-[![Build Status][1]][2]
+[](https://travis-ci.org/hakanensari/peddler)
+[](https://codeclimate.com/github/hakanensari/peddler)
-**Peddler** is a Ruby interface to the [Amazon MWS API][3], a collection of web services that help Amazon sellers programmatically exchange data on their listings, orders, payments, reports, and more.
+**Peddler** is a Ruby interface to the [Amazon MWS API](https://developer.amazonservices.com/), a collection of web services that help Amazon sellers programmatically exchange data on their listings, orders, payments, reports, and more.
To use Amazon MWS, you must have an eligible seller account.
-![Peddler][4]
+
## Configuration
-Require the entire library or a particular API section.
+Require the library and instantiate a client.
```ruby
require 'peddler'
-# require 'mws/orders'
+client = MWS.orders
```
-Instantiate a client.
+You can set up credentials when instantiating:
```ruby
-client = MWS::Orders.new
-```
+client = MWS.orders(
+ marketplace_id: 'A1F83G8C2ARO7P',
+ merchant_id: 'A2A9WNXCU02UZW',
+ aws_access_key_id: 'AKIVICHZMZ2JRSSLC27W',
+ aws_secret_access_key: 'rOMa3ydPBTJ3AD0bxERTOX0Fv0fAC6Q0s6/czMZO'
+)
-Set the credentials.
+Or you can set them via `Client#configure`.
```ruby
client.configure do |c|
c.marketplace_id = 'A1F83G8C2ARO7P'
c.merchant_id = 'A2A9WNXCU02UZW'
c.aws_access_key_id = 'AKIVICHZMZ2JRSSLC27W'
c.aws_secret_access_key = 'rOMa3ydPBTJ3AD0bxERTOX0Fv0fAC6Q0s6/czMZO'
end
```
-If you have only a single set of credentials, you may prefer to use environment variables.
+Or you may use environment variables if you have only a single set of credentials:
```sh
export MWS_MARKETPLACE_ID="A1F83G8C2ARO7P"
export MWS_MERCHANT_ID="A2A9WNXCU02UZW"
export AWS_ACCESS_KEY_ID="AKIVICHZMZ2JRSSLC27W"
@@ -78,14 +83,16 @@
[Read more](http://rubydoc.info/github/hakanensari/peddler/MWS/FulfillmentInventory)
### Fulfillment Outbound Shipment
-**Not implemented**
+**Partially implemented**
The MWS Fulfillment Outbound Shipment API enables you to fulfill orders placed through channels other than Amazon's retail web site, using your inventory in the Amazon Fulfillment Network. You can request previews of potential fulfillment orders that return estimated shipping fees and shipping dates based on shipping speed. You can get detailed item-level, shipment-level, and order-level information for any existing fulfillment order that you specify. You can also request lists of existing fulfillment orders based on when they were fulfilled and by the fulfillment method associated with them.
+Support for creating and cancelling fulfillment orders has been implemented, but the rest of the API is not supported yet.
+
[Read more](http://rubydoc.info/github/hakanensari/peddler/MWS/FulfillmentOutboundShipment)
### Off Amazon Payments
The MWS Off-Amazon Payments API helps you to process payments for purchases made by buyers on your website using the Login and Pay with Amazon service. This API enables you to programmatically retrieve shipping and payment information provided by the buyer from their Amazon account. It allows you to authorize, capture, and refund payments, enabling a variety of payments scenarios.
@@ -125,10 +132,5 @@
### Subscriptions
The Amazon MWS Subscriptions API section enables you to subscribe to receive notifications that are relevant to your business with Amazon. With the operations in the Subscriptions API section, you can register to receive important information from Amazon without having to poll the Amazon MWS service. Instead, the information is sent directly to you when an event occurs to which you are subscribed.
[Read more](http://rubydoc.info/github/hakanensari/peddler/MWS/Subscriptions)
-
-[1]: https://travis-ci.org/hakanensari/peddler.png
-[2]:https://travis-ci.org/hakanensari/peddler
-[3]: https://developer.amazonservices.com/
-[4]: http://f.cl.ly/items/231z2m0r1Q2o2q1n0w1N/peddler.jpg