Code clean up for 3.1.1 release (#22)

## 3.1.1 Release

+ upping the version number and validated that updater catches
+ logger var needs to be declared a global in the class or doesn't get set as global until called, which is causing problems with downstream dependencies
+ same thing with the api global var
+ added some notes

* adding better merging

* updating readme for install

* fixed typo

Author: aguywithanidea

CHANGELOG.md

@@ -1,5 +1,10 @@
 ### Changelog
 
+#### 3.1.1
+* Released: 2020-09*05
+* [[#21](https://github.com/HeyPublisher/amazon-book-store/issues/21)] : Fixed bug when resetting default ASINs by clearing the field and saving.
+* Updated the README to better explain how to install directly from GitHub.
+
 #### 3.1.0
 * Released: 2020-07-25
 * [[#18](https://github.com/HeyPublisher/amazon-book-store/issues/18)] : Amazon Brazil is now supported

README.md

@@ -10,40 +10,77 @@ You can sell specific products on specific pages of your website, or define a 'p
 
 ### Installation
 
-**Install the Widget**
+#### Install Plugin
 
-Install the plugin, then activate it.  Once activated, configure the Widget:
+* Go to the [GitHub repository](https://github.com/HeyPublisher/amazon-book-store) and download the plugin.
 
-* First, drag the 'Amazon Book Store' widget to your sidebar.
-* Where prompted, set the "Title" you want displayed above the widget
-* Select how many products you want to offer for sale at one time within the widget, 1 or 2.
+* Click on the Download ZIP link and save it in your `wp-content/plugins` directory.
+![Download Zip File](images/install-1.jpg)
 
-**Configure the ASIN pool**
+* Extract the files to a sub-directory called `support-great-writers`.  _This will ensure you can install from either WordPress or GitHub without conflict._
 
-Navigate to 'Settings' -> 'Amazon Book Store'.  Input your Amazon Affiliate ID and country, the add the ASINs for the products you want to be displayed in the widget.  See [How to Find Amazon ASINs](https://www.amazon.com/gp/seller/asin-upc-isbn-info.html) for more information.  There are two categorizations of settings:
+  *Using cURL, you can do all of the above with one command:*
 
-* POST Specific:  When set, these products will be offered for sale when users read the associated POST.
-* Default: If the request is to a POST that does not have specific ASINs defined, the widget will display products from this group.
+  `curl -Lo sgw.zip https://github.com/HeyPublisher/support-great-writers/archive/master.zip && unzip sgw.zip && mv support-great-writers-master support-great-writers`
 
-### Frequently Asked Questions
+* Active the plugin via the WordPress plugin menu.
+![Activate](images/install-2.jpg)
+
+* You can keep the plugin updated within WordPress by clicking on the link.
+![Update Plugin](images/install-3.jpg)
+
+#### Install and Configure Widget
+
+##### Install the Widget
 
-**Can I Use This Widget More Than Once In My Sidebar?**
-Yes.  Absolutely.  The widget will keep track of which products have already been displayed on the page and will ensure that duplicates are not shown.
+* Navigate to **Appearance > Widgets** in the WordPress Admin menu
+* Drag the 'Amazon Book Store' widget to your sidebar.
+* Give the widget a title
+* Select whether to display 1 or 2 products at a time in the sidebar
+* Click the "Save" button
+![Install Widget](images/install-4.jpg)
 
-### Screenshots
+##### Basic Settings
 
-1. Widget displayed in the Widget manager.
+* Navigate to **Settings > Amazon Book Store** in the WordPress Admin menu
+* Select the country for your Amazon Affiliate ID
+* Input your own Amazon Affiliate ID
+  * You can register as an [Amazon Affiliate here](https://affiliate-program.amazon.com)
+* Input a comma-separated list of ASINs you want to display when a POST-specific override has not be provided
+  * See [How to Find Amazon ASINs](https://www.amazon.com/gp/seller/asin-upc-isbn-info.html) for more information
 
-  ![image](https://github.com/heypublisher/amazon-book-store/blob/master/screenshot-1.jpg?raw=true)
+![Install Widget](images/install-5.jpg)
 
-1. Widget displayed in the Side-Bar (your styling may differ)
+##### Advanced Settings
 
-  ![image](https://github.com/heypublisher/amazon-book-store/blob/master/screenshot-2.jpg?raw=true)
+You can add POST-specific ASIN's from the Settings page by doing:
+* Click the "Select" drop-down list next to the **Add New Post ASINs** label at the bottom of the screen
+* Select the POST you want to add ASINs for
+  * The screen will update, displaying the post name with an input field
 
-3. Widget process flow, illustrating how the products are selected for display
+![Install Widget](images/install-6.jpg)
+* Input the ASINs you want
+* Click the **Update Settings** button when done
+![Install Widget](images/install-7.jpg)
 
-  ![image](https://github.com/heypublisher/amazon-book-store/blob/master/screenshot-3.jpg?raw=true)
+You can also add POST-specific ASIN's directly from the POST Edit screen by doing:
 
-4. ASIN configuration for POSTs and for Default pool
+* Edit the POST you want to configure
+* At the bottom of the Edit screen you will see the **Custom Fields** editor
+* Click the ** Enter new** link
+![Install Widget](images/install-8.jpg)
+* Input a comma-separated list of ASINs you want to display
+* Click the **Add Custom Field** button to save your selection
+![Install Widget](images/install-9.jpg)
+
+You can Add or Edit ASINs from either the plugin settings page, or from an individual POST's Edit screen.
+
+### Frequently Asked Questions
 
-  ![image](https://github.com/heypublisher/amazon-book-store/blob/master/screenshot-4.jpg?raw=true)
+* **How many ASINs can I use per POST?**  The widget allows a maximum of 10 ASINs per POST.
+* **But the plugin only shows 2 products at a time?** If you have more ASINs configured than the plugin can display, it will randomize the products to display.  
+![Install Widget](images/install-10.jpg)
+* **How can I track if people are clicking or buying?**  Login to your [Amazon Affiliate](https://affiliate-program.amazon.com) account and look for the Affiliate ID you used in the Settings.  Clicks can sometimes take up to 24 hours to display in your Affiliate report.
+* **How does the plugin decide which ASINs to display?** The plugin will use the following logic.
+![image](screenshot-3.jpg)
+* **What if I find a bug?** [Tell us about it](https://github.com/HeyPublisher/amazon-book-store/issues).  You can create an issue at GitHub and we will fix it as soon as possible.