@sesamy/sesamy-js 1.0.2 → 1.0.4

package/README.md

@@ -14,11 +14,25 @@ The following events are tracked:
 
 ## API
 
+The following methods are available on the `sesamy` object:
+
+- `init` - Initializes the sesamy-js library
+- `getEntitlement` - Fetches a single entitlement by id
+- `getEntitlements` - Fetches the user's entitlements
+- `getProfile` - Fetches the user's profile
+
+## Events
+
+The following events are emitted by the sesamy-js library:
+
+- `sesamyReady` - Emitted when the `sesamy-js` library is ready to be used
+- `sesamyAuthenticated` - Emitted when the user is authenticated
+
 ## Usage
 
 The script can either be initiated with a JSON object in a script tag or by calling the init method.
 
-The script will look for a script tag with the id `sesamy-js`, and if it isn't found it will wait for a call to the init function before initializing.
+The script will look for a script tag with the id `sesamy-js`, and if it isn't found it will wait for a call to the init function before initializing. The only required part is the `clientId` attribute.
 
 ```html
 <script type="application/json" id="sesamy-js">
@@ -28,7 +42,15 @@ The script will look for a script tag with the id `sesamy-js`, and if it isn't f
 </script>
 ```
 
-## TODO
+These are the available configuration options, with their default values:
 
-- We should consider replacing the saturated library as it keeps the messages in memory. We should maybe replace it with a library that stores the messages in local storage in case the user is offline.
-- Ensure that the client-id is fetched from the page or config
+```javascript
+{
+  clientId: null,
+  namespace: 'sesamy',
+  analytics: {
+    enabled: true,
+    endpoint: 'https://logs.sesamy.com/events'
+  }
+}
+```