updated readme

derwentx · derwentx · commit 1dea17e79b42 · 2017-10-25T23:45:06.000+11:00
thanks Paul
diff --git a/README.rst b/README.rst
@@ -95,6 +95,7 @@ Setup for the old Wordpress API:
     )
 
 Setup for the new WP REST API v2:
+(Note: the username and password are required so that it can fill out the oauth request token form automatically for you)
 
 .. code-block:: python
 
@@ -107,7 +108,9 @@ Setup for the new WP REST API v2:
         api="wp-json",
         version="wp/v2",
         wp_user="XXXX",
-        wp_pass="XXXX"
+        wp_pass="XXXX",
+        oauth1a_3leg=True,
+        creds_store="~/.wc-api-creds.json"
     )
 
 Setup for the old WooCommerce API v3:
@@ -141,27 +144,29 @@ Setup for the new WP REST API integration (WooCommerce 2.6 or later):
 Options
 ~~~~~~~
 
-+-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
-|         Option        |     Type    | Required |                                              Description                                              |
-+=======================+=============+==========+=======================================================================================================+
-| ``url``               | ``string``  | yes      | Your Store URL, example: http://wp.dev/                                                               |
-+-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
-| ``consumerKey``       | ``string``  | yes      | Your API consumer key                                                                                 |
-+-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
-| ``consumerSecret``    | ``string``  | yes      | Your API consumer secret                                                                              |
-+-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
-| ``api``               | ``string``  | no       | Determines which api to use, defaults to ``wp-json``, can be arbitrary: ``wc-api``, ``oembed``        |
-+-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
-| ``version``           | ``string``  | no       | API version, default is ``wp/v2``, can be ``v3`` or  ``wc/v1`` if using ``wc-api``                    |
-+-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
-| ``timeout``           | ``integer`` | no       | Connection timeout, default is ``5``                                                                  |
-+-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
-| ``verify_ssl``        | ``bool``    | no       | Verify SSL when connect, use this option as ``False`` when need to test with self-signed certificates |
-+-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
-| ``basic_auth``        | ``bool``    | no       | Force Basic Authentication, can be through query string or headers (default)                          |
-+-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
-| ``query_string_auth`` | ``bool``    | no       | Force Basic Authentication as query string when ``True`` and using under HTTPS, default is ``False``  |
-+-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
++-----------------------+-------------+----------+------------------------------------------------------------------------------------------------------------------+
+|         Option        |     Type    | Required |                                              Description                                                         |
++=======================+=============+==========+==================================================================================================================+
+| ``url``               | ``string``  | yes      | Your Store URL, example: http://wp.dev/                                                                          |
++-----------------------+-------------+----------+------------------------------------------------------------------------------------------------------------------+
+| ``consumerKey``       | ``string``  | yes      | Your API consumer key                                                                                            |
++-----------------------+-------------+----------+------------------------------------------------------------------------------------------------------------------+
+| ``consumerSecret``    | ``string``  | yes      | Your API consumer secret                                                                                         |
++-----------------------+-------------+----------+------------------------------------------------------------------------------------------------------------------+
+| ``api``               | ``string``  | no       | Determines which api to use, defaults to ``wp-json``, can be arbitrary: ``wc-api``, ``oembed``                   |
++-----------------------+-------------+----------+------------------------------------------------------------------------------------------------------------------+
+| ``version``           | ``string``  | no       | API version, default is ``wp/v2``, can be ``v3`` or  ``wc/v1`` if using ``wc-api``                               |
++-----------------------+-------------+----------+------------------------------------------------------------------------------------------------------------------+
+| ``timeout``           | ``integer`` | no       | Connection timeout, default is ``5``                                                                             |
++-----------------------+-------------+----------+------------------------------------------------------------------------------------------------------------------+
+| ``verify_ssl``        | ``bool``    | no       | Verify SSL when connect, use this option as ``False`` when need to test with self-signed certificates            |
++-----------------------+-------------+----------+------------------------------------------------------------------------------------------------------------------+
+| ``basic_auth``        | ``bool``    | no       | Force Basic Authentication, can be through query string or headers (default)                                     |
++-----------------------+-------------+----------+------------------------------------------------------------------------------------------------------------------+
+| ``query_string_auth`` | ``bool``    | no       | Use query string for Basic Authentication when ``True`` and using HTTPS, default is ``False`` which uses header  |
++-----------------------+-------------+----------+------------------------------------------------------------------------------------------------------------------+
+| ``creds_store``       | ``string``  | no       | JSON file where oauth verifier is stored (only used with OAuth_3Leg)                                             |
++-----------------------+-------------+----------+------------------------------------------------------------------------------------------------------------------+
 
 Methods
 -------
