attestid_js_sdk 0.1.3 → 0.1.5

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 +19 -1
  2. package/package.json +9 -1
package/README.md CHANGED
@@ -6,9 +6,17 @@ JavaScript / TypeScript SDK for the AttestID KYC API: ID capture, photo quality
6
6
 
7
7
  ```bash
8
8
  npm install attestid_js_sdk
9
+ # or
10
+ pnpm add attestid_js_sdk
11
+ # or
12
+ yarn add attestid_js_sdk
13
+ # or
14
+ bun add attestid_js_sdk
9
15
  ```
10
16
 
11
- React components are available from `attestid_js_sdk/react` and require `react` and `react-dom` 18 or later.
17
+ Works with ES modules (`import`) and CommonJS (`require`), with TypeScript types included.
18
+
19
+ React components are available from `attestid_js_sdk/react` and require `react` and `react-dom` 18 or later. React is optional if you only use the core client.
12
20
 
13
21
  ## Setup
14
22
 
@@ -150,6 +158,16 @@ All errors extend `AttestIDError` and include a `code`.
150
158
 
151
159
  Modern browsers over HTTPS, or Node.js 19+.
152
160
 
161
+ ## Publishing
162
+
163
+ ```bash
164
+ npm login
165
+ ```
166
+
167
+ 1. Make your changes and commit them.
168
+ 2. Run `npm version patch` to bump the version.
169
+ 3. Run `git push --follow-tags`, then `npm publish`.
170
+
153
171
  ## License
154
172
 
155
173
  MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "attestid_js_sdk",
3
- "version": "0.1.3",
3
+ "version": "0.1.5",
4
4
  "description": "Official JavaScript/TypeScript SDK for the AttestID KYC API",
5
5
  "author": "BrimSage",
6
6
  "license": "MIT",
@@ -45,6 +45,14 @@
45
45
  "react": ">=18.0.0",
46
46
  "react-dom": ">=18.0.0"
47
47
  },
48
+ "peerDependenciesMeta": {
49
+ "react": {
50
+ "optional": true
51
+ },
52
+ "react-dom": {
53
+ "optional": true
54
+ }
55
+ },
48
56
  "devDependencies": {
49
57
  "@types/react": "^19.0.0",
50
58
  "@types/react-dom": "^19.0.0",