@eyepop.ai/eyepop 0.12.0 → 0.14.0

package/README.md

@@ -3,7 +3,7 @@ The EyePop.ai Node SDK provides convenient access to the EyePop.ai's inference A
 TypeScript or JavaScript language.
 ## Installation
 ```shell
-npm install --save eyepop
+npm install --save @eyepop.ai/eyepop
 ```
 ## Configuration
 The EyePop SDK needs to be configured with the __Pop Id__ and your __Authentication Credentials__. Credentials can 
@@ -37,8 +37,7 @@ Equivalent, but shorter:
 ```typescript
 import { EyePopSdk } from '@eyepop.ai/eyepop'
 (async() => {
-    const endpoint = EyePopSdk.endpoint()
-    await endpoint.connect()
+    const endpoint = await EyePopSdk.endpoint().connect()
     // do work ....
     await endpoint.disconnect()
 })
@@ -77,13 +76,24 @@ import { EyePopSdk } from '@eyepop.ai/eyepop'
 <body>
 <script>
     document.addEventListener("DOMContentLoaded", async (event) => {
-        let endpoint = await EyePopSdk.endpoint({ auth: { oAuth: true }, popId: '< Pop Id>' }).connect();
+        let endpoint = await EyePopSdk.endpoint({ auth: { oAuth2: true }, popId: '< Pop Id>' }).connect();
         // do work ....
         await endpoint.disconnect();
     });
 </script>
 </body>
 ```
+To use an alternative environment, e.g. STAGING vs PRODUCTION, pass in the adjusted Auth0 configuration:
+```javascript
+// ...
+let endpoint = await EyePopSdk.endpoint({ 
+  auth: { oAuth2: {
+    audience: "https://dev-app.eyepop.ai",
+    domain: "dev-eyepop.us.auth0.com",
+    clientId: "jktx3YO2UnbkNPvr05PQWf26t1kNTJyg"
+  } }, popId: '< Pop Id>' }).connect();
+// ...
+```
 ## Usage Examples
 ### Uploading and processing one single image
 ```typescript
@@ -108,7 +118,7 @@ EYEPOP_SECRET_KEY and load the worker configuration for the Pop identified by EY
 2. Call `endpoint.connect()` before any job is submitted and `endpoint.disconnect()` to release all resources.
 3. `endpoint.process({path:'examples/example.jpg'})` initiates the upload to the local file to the worker service. 
 The image will be queued and processed immediately when the worker becomes available.
-The result of endpoint.upload() implements `AsyncIterable<Prediction>` which can be iterated fir 'for await' as 
+The result of endpoint.upload() implements `AsyncIterable<Prediction>` which can be iterated with 'for await' as 
 shown in the example above. Predictions will become available when the submitted file becomes processed by the worker 
 and results are efficiently streamed back to the calling client. If the uploaded file is a video
 e.g. 'video/mp4' or image container format e.g. 'image/gif', the client will receive one prediction per image frame