@seclai/sdk 0.0.1 → 1.0.1

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 +12 -0
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -8,6 +8,18 @@ This is the official Seclai JavaScript SDK with TypeScript typings.
8
8
  npm install @seclai/sdk
9
9
  ```
10
10
 
11
+ ## API documentation
12
+
13
+ Online API documentation (latest):
14
+
15
+ https://seclai.github.io/seclai-javascript/1.0.1/
16
+
17
+ Generate HTML docs into `build/docs/`:
18
+
19
+ ```bash
20
+ npm run docs
21
+ ```
22
+
11
23
  ## Usage
12
24
 
13
25
  ```ts
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seclai/sdk",
3
- "version": "0.0.1",
3
+ "version": "1.0.1",
4
4
  "description": "Seclai JavaScript SDK",
5
5
  "keywords": [
6
6
  "Seclai",
@@ -27,15 +27,15 @@
27
27
  "LICENSE",
28
28
  "README.md"
29
29
  ],
30
- "homepage": "https://github.com/seclai/seclai-javascript",
30
+ "homepage": "https://seclai.github.io/seclai-javascript/latest/",
31
31
  "bugs": {
32
32
  "url": "https://github.com/seclai/seclai-javascript/issues",
33
33
  "email": "support@seclai.com"
34
34
  },
35
35
  "repository": "github:seclai/seclai-javascript",
36
36
  "scripts": {
37
- "version:apply": "node scripts/set-version.mjs apply",
38
- "version:restore": "node scripts/set-version.mjs restore",
37
+ "version:apply": "node scripts/set-version.mjs apply && node scripts/set-readme-version.mjs apply",
38
+ "version:restore": "node scripts/set-readme-version.mjs restore && node scripts/set-version.mjs restore",
39
39
  "generate": "openapi-typescript openapi/seclai.openapi.json -o src/openapi.ts",
40
40
  "build": "npm run generate && tsup src/index.ts --format esm,cjs --dts",
41
41
  "build:versioned": "npm run version:apply && npm run build && npm run version:restore",