docs: fix issues regarding imports and highlight docs

ScaleLeap · Jun 30, 2020 · 50d53a9 · 50d53a9
1 parent efb725e
commit 50d53a9
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -18,9 +18,7 @@ A fully typed TypeScript SDK library for Amazon MWS API
 $ npm i -s @scaleleap/amazon-mws-api-sdk
 ```
 
-## Documentation (WIP)
-
-[Click me!](docs)
+## [Click here for the full **Documentation**](docs)
 
 ## Example
 ---
@@ -32,7 +30,7 @@ import {
   MWSOptions,
   Sellers,
   Orders
-} from 'amazon-mws-api-sdk'
+} from '@scaleleap/amazon-mws-api-sdk'
 
 const mwsOptions: MWSOptions = {
   marketplace: amazonMarketplaces.US,
@@ -64,7 +62,7 @@ const main = async () => {
   })
 }
 ```
-More examples in the `/examples` folder!
+## [More examples in the `/examples` folder!](examples)
 
 ## Authors or Acknowledgments
 

diff --git a/examples/fulfillment-inventory/list-inventory-supply.ts b/examples/fulfillment-inventory/list-inventory-supply.ts
@@ -1,4 +1,6 @@
 // eslint-disable-next-line eslint-comments/disable-enable-pair
+/* eslint-disable import/no-unresolved */
+// eslint-disable-next-line eslint-comments/disable-enable-pair
 /* eslint-disable @typescript-eslint/no-unused-vars */
 
 /**
@@ -8,7 +10,7 @@
  */
 
 /**
- * import from 'amazon-mws-api-sdk'
+ * import from '@scaleleap/amazon-mws-api-sdk'
  */
 import {
   amazonMarketplaces,
@@ -19,7 +21,7 @@ import {
   MWSOptions,
   RequestMeta,
   ResponseGroup,
-} from '../../src'
+} from '@scaleleap/amazon-mws-api-sdk'
 
 /**
  * Configure the HttpClient

diff --git a/examples/get-service-status.ts b/examples/get-service-status.ts
@@ -1,9 +1,12 @@
 // eslint-disable-next-line eslint-comments/disable-enable-pair
+/* eslint-disable import/no-unresolved */
+// eslint-disable-next-line eslint-comments/disable-enable-pair
 /* eslint-disable @typescript-eslint/no-unused-vars */
 /**
- * import from 'amazon-mws-api-sdk'
+ * import from '@scaleleap/amazon-mws-api-sdk'
  */
-import { amazonMarketplaces, HttpClient, MWSOptions, Sellers } from '../src'
+import { amazonMarketplaces, HttpClient, MWSOptions, Sellers } from '@scaleleap/amazon-mws-api-sdk'
+
 import { ServiceStatus } from '../src/parsing'
 
 /**

diff --git a/examples/orders/list-orders.ts b/examples/orders/list-orders.ts
@@ -1,14 +1,15 @@
 // eslint-disable-next-line eslint-comments/disable-enable-pair
+/* eslint-disable import/no-unresolved */
+// eslint-disable-next-line eslint-comments/disable-enable-pair
 /* eslint-disable @typescript-eslint/no-unused-vars */
-
 /**
  * More usage examples at
  * /test/integration/orders.test.ts
  * /test/unit/orders.test.ts
  */
 
 /**
- * import from 'amazon-mws-api-sdk'
+ * import from '@scaleleap/amazon-mws-api-sdk'
  */
 import {
   amazonMarketplaces,
@@ -22,7 +23,7 @@ import {
   OrderStatus,
   PaymentMethod,
   RequestMeta,
-} from '../../src'
+} from '@scaleleap/amazon-mws-api-sdk'
 /**
  * Configure the HttpClient
  */

diff --git a/examples/using-next-tokens.ts b/examples/using-next-tokens.ts
@@ -1,9 +1,17 @@
 // eslint-disable-next-line eslint-comments/disable-enable-pair
+/* eslint-disable import/no-unresolved */
+// eslint-disable-next-line eslint-comments/disable-enable-pair
 /* eslint-disable @typescript-eslint/no-unused-vars */
 /**
- * import from 'amazon-mws-api-sdk'
+ * import from '@scaleleap/amazon-mws-api-sdk'
  */
-import { amazonMarketplaces, HttpClient, MWSOptions, NextToken, Sellers } from '../src'
+import {
+  amazonMarketplaces,
+  HttpClient,
+  MWSOptions,
+  NextToken,
+  Sellers,
+} from '@scaleleap/amazon-mws-api-sdk'
 
 /**
  * Configure the HttpClient