Fix remove links from ready me and use github pages

Author: bendvc

CHANGELOG.md

@@ -1,2 +1,7 @@
+## To be released
+- Update README
+- Remove reference to test Salesforce instance
+- Compile docs
+
 ## v0.2.0 (November 1, 2017)
 - Initial release

README.md

@@ -30,7 +30,6 @@ <h1 class="page-title">Source: ApiClient.js</h1>
 /* Copyright (c) 2017 Mobify Research &amp; Development Inc. All rights reserved. */
 /* * *  *  * *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  * */
 
-
 /**
  * Shop API
  * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
@@ -43,7 +42,6 @@ <h1 class="page-title">Source: ApiClient.js</h1>
  * Do not edit the class manually.
  *
  */
-
 import superagent from 'superagent'
 import querystring from 'querystring'
 
@@ -55,7 +53,7 @@ <h1 class="page-title">Source: ApiClient.js</h1>
  */
 
 const defaultConfig = {
-    basePath: 'https://mobify-tech-prtnr-na03-dw.demandware.net/s/2017refresh/dw/shop/v17_8',
+    basePath: 'https://localhost/s/siteId/dw/shop/v17_8',
     defaultHeaders: {},
     timeout: 60000,
     cache: true,
@@ -72,7 +70,6 @@ <h1 class="page-title">Source: ApiClient.js</h1>
 export default class ApiClient {
 
     constructor(config = defaultConfig) {
-
         const {
             basePath,
             defaultHeaders,
@@ -92,7 +89,7 @@ <h1 class="page-title">Source: ApiClient.js</h1>
         /**
          * The base URL against which to resolve every API call's (relative) path.
          * @type {String}
-         * @default https://mobify-tech-prtnr-na03-dw.demandware.net/s/2017refresh/dw/shop/v17_8
+         * @default https://localhost/s/siteId/dw/shop/v17_8
          */
         this.basePath = basePath.replace(/\/+$/, '')
 
@@ -125,7 +122,6 @@ <h1 class="page-title">Source: ApiClient.js</h1>
             customers_auth.password = clientPassword
         }
 
-
         /**
          * The default HTTP headers to be included for all API calls.
          * @type {Array.&lt;String>}
@@ -710,7 +706,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-ap
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Oct 31 2017 14:43:14 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Nov 01 2017 16:46:35 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

docs/ApiClient.js.html

@@ -30,7 +30,6 @@ <h1 class="page-title">Source: api/BasketsApi.js</h1>
 /* Copyright (c) 2017 Mobify Research &amp; Development Inc. All rights reserved. */
 /* * *  *  * *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  * */
 
-
 /**
  * Shop API
  * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
@@ -1581,7 +1580,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-ap
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Oct 31 2017 14:43:14 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Nov 01 2017 16:46:35 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

docs/api_BasketsApi.js.html

@@ -30,7 +30,6 @@ <h1 class="page-title">Source: api/CategoriesApi.js</h1>
 /* Copyright (c) 2017 Mobify Research &amp; Development Inc. All rights reserved. */
 /* * *  *  * *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  * */
 
-
 /**
  * Shop API
  * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
@@ -65,8 +64,6 @@ <h1 class="page-title">Source: api/CategoriesApi.js</h1>
         this.apiClient = apiClient || ApiClient.instance
     }
 
-
-
     /**
      * When you use the URL template below, the server returns a category identified by its id; by default, the server
      * also returns the first level of subcategories, but you can specify another level by setting the levels
@@ -86,7 +83,6 @@ <h1 class="page-title">Source: api/CategoriesApi.js</h1>
             throw new Error('Missing the required parameter \'id\' when calling getCategoriesByID')
         }
 
-
         const pathParams = {
             id
         }
@@ -142,7 +138,6 @@ <h1 class="page-title">Source: api/CategoriesApi.js</h1>
             throw new Error('Missing the required parameter \'ids\' when calling getCategoriesByIDs')
         }
 
-
         const pathParams = {
             ids
         }
@@ -178,8 +173,6 @@ <h1 class="page-title">Source: api/CategoriesApi.js</h1>
                 return response_and_data.data
             })
     }
-
-
 }
 </code></pre>
         </article>
@@ -197,7 +190,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-ap
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Oct 31 2017 14:43:14 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Nov 01 2017 16:46:35 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

docs/api_CategoriesApi.js.html

@@ -30,7 +30,6 @@ <h1 class="page-title">Source: api/ContentApi.js</h1>
 /* Copyright (c) 2017 Mobify Research &amp; Development Inc. All rights reserved. */
 /* * *  *  * *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  * */
 
-
 /**
  * Shop API
  * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
@@ -190,7 +189,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-ap
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Oct 31 2017 14:43:14 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Nov 01 2017 16:46:35 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

docs/api_ContentApi.js.html

@@ -30,7 +30,6 @@ <h1 class="page-title">Source: api/ContentSearchApi.js</h1>
 /* Copyright (c) 2017 Mobify Research &amp; Development Inc. All rights reserved. */
 /* * *  *  * *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  * */
 
-
 /**
  * Shop API
  * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
@@ -160,7 +159,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-ap
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Oct 31 2017 14:43:14 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Nov 01 2017 16:46:35 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

docs/api_ContentSearchApi.js.html

@@ -30,7 +30,6 @@ <h1 class="page-title">Source: api/CustomObjectsApi.js</h1>
 /* Copyright (c) 2017 Mobify Research &amp; Development Inc. All rights reserved. */
 /* * *  *  * *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  * */
 
-
 /**
  * Shop API
  * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
@@ -137,7 +136,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-ap
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Oct 31 2017 14:43:14 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Nov 01 2017 16:46:35 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

docs/api_CustomObjectsApi.js.html

@@ -30,7 +30,6 @@ <h1 class="page-title">Source: api/CustomersApi.js</h1>
 /* Copyright (c) 2017 Mobify Research &amp; Development Inc. All rights reserved. */
 /* * *  *  * *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  * */
 
-
 /**
  * Shop API
  * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
@@ -1887,7 +1886,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-ap
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Oct 31 2017 14:43:14 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Nov 01 2017 16:46:35 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

docs/api_CustomersApi.js.html

@@ -30,7 +30,6 @@ <h1 class="page-title">Source: api/FoldersApi.js</h1>
 /* Copyright (c) 2017 Mobify Research &amp; Development Inc. All rights reserved. */
 /* * *  *  * *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  * */
 
-
 /**
  * Shop API
  * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
@@ -200,7 +199,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-ap
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Oct 31 2017 14:43:14 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Nov 01 2017 16:46:35 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>