guidewhale 0.1.6 → 0.1.7

package/README.md

@@ -1,6 +1,8 @@
-# guide-whale-sdk-test
+# GuideWhale Client Script
 
-GuideWhale client installation using npm. The module exports a 
+GuideWhale client installation using npm. The module exports a `guidewhale` object, which is used to reference all of our SDK methods.
+
+The script is automatically loaded when the module is imported. Any methods that are called before the script is loaded will be queued and executed after the script finishes loading.
 
 ## Installation
 
@@ -9,21 +11,35 @@ npm install guidewhale
 ```
 
 ## Usage
+Simply import gwhale object from 'guidewhale' package and replace placeholder values with your environment token and user/company properties (remove any non-required properties if you don't need them) as shown below:
 
 ```typescript
-import { greet } from 'guide-whale-sdk-test';
-
-console.log(greet('World')); // Output: Hello, World!
+import { gwhale } from 'guidewhale';
+
+gwhale.init("<guidewhale_environment_code>", {
+    user: {
+        user_id: <user_id>,                     // REQUIRED - unique user identifier (e.g. 100000356, '6099047b-660b-4f2e-a878-fb66a12c1840', 'john.smith@example.com')
+        email: <user_email>,                    // RECOMMENDED - email is used as the key to map user data for most integrations (e.g. 'john.smith@example.com')
+        first_name: <user_first_name>,          // RECOMMENDED - can be used to personalize GuideWhale content (e.g. 'John')
+        last_name: <user_last_name>,            // RECOMMENDED - can be used to personalize GuideWhale content (e.g. 'Smith')
+        date_signed_up: <user_signup_date>,     // RECOMMENDED - can be used to selectively show checklists to new users (Must be ISO8601 string - e.g. "2024-01-01T12:00:00Z")
+        ...                                     // OPTIONAL - additional user properties (e.g. gender: 'female')
+    },
+    company: {
+        company_id: <company_id>,               // REQUIRED - unique company identifier (e.g. 100000356, '6099047b-660b-4f2e-a878-fb66a12c1840')
+        name: <company_name>,                   // RECOMMENDED - can be used to personalize GuideWhale content (e.g. 'GuideWhale Inc.')
+        plan: <company_subscription_plan>,      // RECOMMENDED - can be used to target users for upselling, discounts, and promotions (e.g. 'free', 'basic', 'pro')
+        ...                                     // OPTIONAL - additional company properties (e.g. location: 'United States')
+    },
+    membership: {
+        is_primary: <user_is_primary_contact>,  // RECOMMENDED - whether user is the primary contact for the company (e.g. true, false)
+        role: <user_company_role>,              // RECOMMENDED - you can target users based on their role in the company (e.g. 'admin', 'user', 'guest')
+        ...                                     // OPTIONAL - additional user company membership properties (e.g. employee_number: 12345)
+    }
+});
 ```
 
 ## Development
 
 1. Install dependencies: `npm install`
-2. Make changes in `src/`
-3. Build: `npm run build`
-4. Test: `npm test`
-
-## License
-
-MIT
-Repository to publish GuideWhale SDK as a public NPM package
+2. Build: `npm run build`

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "guidewhale",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "GuideWhale SDK client script loader",
   "type": "module",
-  "main": "dist/index.js",
-  "module": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/guidewhale.js",
+  "module": "dist/guidewhale.js",
+  "types": "dist/guidewhale.d.ts",
   "files": [
     "dist"
   ],