add docs (#896)

* add docs * add more to readme for npm
CarnegieLearningWeb · Aug 3, 2023 · 91697f0 · 91697f0
1 parent 6f4227a
commit 91697f0
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/clientlibs/js/src/UpgradeClient.ts b/clientlibs/js/src/UpgradeClient.ts
@@ -48,6 +48,31 @@ import Assignment from './Assignment';
 * ```
 */
 
+/**
+ * UpGradeClient is the main class for interacting with the UpGrade API.
+ * 
+ * @example
+* ```typescript
+* import UpgradeClient from 'upgrade_client_lib/dist/browser';
+* ```
+*
+* ```typescript
+* import UpgradeClient from 'upgrade_client_lib/dist/node';
+* ```
+*
+* General UpGrade types can also be accessed as named exports:
+* ```typescript
+* import UpgradeClient, { IExperimentAssignment } from 'upgrade_client_lib/dist/browser';
+* ```
+*
+* SDK-Specific types can be accessed also:
+* ```typescript
+* import { Interfaces } from 'upgrade_client_lib/dist/clientlibs/js/src/identifiers';
+* 
+* const initResponse: Interfaces.IUser = await upgradeClient.init();
+* ```
+*/
+
 export default class UpgradeClient {
   // Endpoints URLs
   private api: UpGradeClientInterfaces.IEndpoints = {