@usermaven/sdk-js 1.0.0 → 1.0.4

package/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2022 UserMaven, Inc.
+
+Copyright (c) 2021 Jitsu Labs, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -2,6 +2,10 @@
 
 Usermaven.js is a JavaScript SDK for [Usermaven](https://usermaven.com).
 
+## Capabilities
+
+- Session Capability via `persistence` and `persistence_name` options.
+
 ## Maintainers Guide
 
 This section is indented only for package maintainers.
@@ -11,7 +15,7 @@ This section is indented only for package maintainers.
  * _**ATTENTION**_: Use `yarn` for everything except publishing
  * To spin off a local development server run `yarn devserver`, then open [http://localhost:8081](http://localhost:8081)
    * The server listens to all changes to src and rebuilds npm and `lib.js` automatically. Open test cases HTML files to see
-     jitsu in action
+     usermaven in action
      * http://localhost:8081/test-case/embed.html - embedded Usermaven
      * http://localhost:8081/test-case/embed-no-init.html - Usermaven without automatic initialization
      * http://localhost:8081/test-case/segment-intercept.html - test segment interception
@@ -19,6 +23,13 @@ This section is indented only for package maintainers.
  * `yarn build` builds both npm package and `lib.js` browser bundle
  * `npm publish --public` to publish the package (change version in `package.json` manually). You need to run `npm login` with your personal
 npmjs account beforehand (make sure you have access to Usermaven team)
+ * In order to check usermaven sdk locally. 
+    * `cd dist/npm` --- navigate to npm directory
+    * `npm link` --- creates a symbolic link to be accessed globally
+    * `cd ../../__tests__/sdk/` --- navigate to sdk test project
+    * `npm i` --- install npm dependencies
+    * `npm link @usermaven/sdk-js` --- use npm package locally whose symlink is just published
+    * `npm start` --- start the application and monitor events
 
 ### Publishing new version