@dtect/security-sdk-js 0.0.6 → 0.0.7

package/README.md

@@ -6,17 +6,13 @@ Security API Javascript SDK by dtect.
 <details>
   <summary>Table of Contents</summary>
   <ol>
-    <li>
-      <a href="#about-the-project">About The Project</a>
-    </li>
     <li>
       <a href="#getting-started">Getting Started</a>
       <ul>
-        <li><a href="#prerequisites">Prerequisites</a></li>
         <li><a href="#installation">Installation</a></li>
       </ul>
     </li>
-		<li>
+    	<li>
       <a href="#implementation">Implementation</a>
     </li>
     	<li>
@@ -24,17 +20,10 @@ Security API Javascript SDK by dtect.
     </li>
     <li><a href="#license">License</a></li>
     <li><a href="#contact">Contact</a></li>
+
   </ol>
 </details>
 
-<!-- ABOUT THE PROJECT -->
-
-## About The Project
-
-Security API SDK
-
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
-
 <!-- GETTING STARTED -->
 
 ## Getting Started
@@ -42,9 +31,9 @@ Security API SDK
 The dtect Security API helps you gather valuable insights about your visitors, enhancing the quality of your survey data.
 This library is responsible for collecting data about the visitor's browser and behavior, send everything to our API and return a Security Result or a Security Token.
 
-### Prerequisites
+_Please refer to [our official documentation](https://docs.dtect.io) to learn more about the dtect Security API_
 
-Get required Public Keys at [https://dtect.security.dashboard.com](https://dtect.security.dashboard.com)
+_**If you want to use our API, please [contact us](https://dtect.io/contact)**_
 
 ### Installation
 
@@ -68,10 +57,12 @@ or CDN
 
 ## NPM Implementation
 
+_Read full documentation about implementation on [our official docs](https://docs.dtect.io/frontend/introduction)_
+
 ### 1. Start initialize security sdk by calling init function.
 
-- Set `clientId` from your [dtect dashboard](https://dtect.security.dashboard.com/keys)
-- Set `apiKey` from your [dtect dashboard](https://dtect.security.dashboard.com/keys)
+- Set your public client id as `clientId`
+- Set your public api key as `apiKey`
 
 ```jsx
 import dtect from "@dtect/security-sdk-js";
@@ -123,7 +114,9 @@ dtect
 
 ```html
 <script>
-  const dtectPromise = import(`cdnurl`).then((dtect) =>
+  const dtectPromise = import(
+    "https://unpkg.com/@dtect/security-sdk-js@latest/dist/index.mjs"
+  ).then((dtect) =>
     dtect.init({
       clientId: "your-public-client-id-from-dashboard", // required
       apiKey: "your-public-api-key-from-dashboard", // required
@@ -152,6 +145,8 @@ dtect
 
 ## Errors
 
+_Read full documentation about errors on [our official docs](https://docs.dtect.io/errors)_
+
 Access the list of error enums from `SecurityAPIError`
 
 ### init()
@@ -174,6 +169,10 @@ You will see these errors on console
 | `FAILED_TO_GET_SECURITY_TOKEN`  | Failed to Generate Security Token        | An error occurred while generating the Security Token.                                             |
 | `FAILED_TO_GET_SECURITY_RESULT` | Failed to Retrieve Security Result       | An error occurred while retrieving the Security Result.                                            |
 
+                                          |
+
+#### NPM implementation with errors
+
 ```jsx
 import dtect, { SecurityAPIError } from "@dtect/security-sdk-js";
 
@@ -191,11 +190,31 @@ dtect
   });
 ```
 
+#### CDN implementation with errors
+
+```jsx
+<script>
+  dtectPromise.then((dtect) =>
+    dtect
+      .getSecurityResult({
+        projectId: "your-project-id-for-deduplication", // required
+      })
+      .then((securityResult) => console.log(securityResult))
+      .catch((error) => {
+        switch(error.message) {
+          case dtect.SecurityAPIError.FAILED_TO_GET_SECURITY_RESULT:
+            // log internally
+        }
+      })
+  );
+</script>
+```
+
 <!-- LICENSE -->
 
-## License
+<!-- ## License
 
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
+<p align="right">(<a href="#readme-top">back to top</a>)</p> -->
 
 <!-- CONTACT -->
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dtect/security-sdk-js",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",