@marteye/studiojs 1.1.0 → 1.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +53 -0
  2. package/package.json +3 -2
package/README.md ADDED
@@ -0,0 +1,53 @@
1
+ # MartEye Studio JavaScript SDK (@marteye/studiojs)
2
+
3
+ This library is a JavaScript SDK that allows you to easily integrate with MartEye Studio's API. It provides methods to interact with various resources, manage data, and leverage the powerful features offered by MartEye Studio.
4
+
5
+ ## Installation
6
+
7
+ You can install the library using npm or yarn:
8
+
9
+ Using npm:
10
+
11
+ ```bash
12
+ npm install @marteye/studiojs
13
+ ```
14
+
15
+ Using yarn:
16
+
17
+ ```bash
18
+ yarn add @marteye/studiojs
19
+ ```
20
+
21
+ ## Usage
22
+
23
+ ### Importing the Library
24
+
25
+ Using ES Modules:
26
+
27
+ ```javascript
28
+ import StudioJS from "@marteye/studiojs";
29
+ ```
30
+
31
+ Or using CommonJS:
32
+
33
+ ```javascript
34
+ let StudioJS = require("@marteye/studiojs");
35
+ ```
36
+
37
+ ### Initializing the SDK
38
+
39
+ Before using the library, initialize it with your API key. For more information on obtaining an API key, please contact your MartEye representative.
40
+
41
+ ```javascript
42
+ let studioClient = StudioJS.init({
43
+ apiKey: "YOUR_API_KEY_HERE",
44
+ });
45
+ ```
46
+
47
+ ## Contributing
48
+
49
+ Contributions are welcome! Please open an issue or submit a pull request if you have suggestions or improvements.
50
+
51
+ ## License
52
+
53
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@marteye/studiojs",
3
- "version": "1.1.0",
3
+ "version": "1.1.2",
4
4
  "description": "MartEye Studio JavaScript SDK",
5
5
  "license": "MIT",
6
6
  "source": "src/index.ts",
@@ -15,7 +15,8 @@
15
15
  "watch": "rollup -c -w",
16
16
  "test": "jest --coverage",
17
17
  "build:types": "tsc --emitDeclarationOnly",
18
- "publish": "npm run build && npm publish --access public"
18
+ "publish": "npm run build && npm publish --access public",
19
+ "adduser": "npm adduser"
19
20
  },
20
21
  "devDependencies": {
21
22
  "@rollup/plugin-commonjs": "^25.0.0",