@cipherstash/protect-ffi 0.9.0 → 0.10.0

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 +13 -2
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -1,7 +1,7 @@
1
- # protect-ffi
1
+ # Protect.js CipherStash Client FFI
2
2
 
3
3
  > [!IMPORTANT]
4
- > If you are looking to implement this package into your application please use the official [protect package](https://github.com/cipherstash/protect).
4
+ > If you are looking to implement this package into your application please use the official [protect package](https://github.com/cipherstash/protectjs).
5
5
 
6
6
  This project provides the JS bindings for the CipherStash Client Rust SDK and is bootstrapped by [create-neon](https://www.npmjs.com/package/create-neon).
7
7
 
@@ -17,6 +17,17 @@ $ npm run build
17
17
 
18
18
  This command uses the [@neon-rs/cli](https://www.npmjs.com/package/@neon-rs/cli) utility to assemble the binary Node addon from the output of `cargo`.
19
19
 
20
+ ## Local setup
21
+
22
+ You can use the `stash` CLI tool to set up your local environment.
23
+
24
+ You will be prompted to sign in or create an account and follow steps to create a keyset and client key.
25
+
26
+ ```sh
27
+ brew install cipherstash/tap/stash
28
+ stash setup
29
+ ```
30
+
20
31
  ## Exploring
21
32
 
22
33
  After building `protect-ffi`, you can explore its exports at the Node console.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cipherstash/protect-ffi",
3
- "version": "0.9.0",
3
+ "version": "0.10.0",
4
4
  "description": "",
5
5
  "main": "./lib/index.cjs",
6
6
  "scripts": {
@@ -52,10 +52,10 @@
52
52
  "@neon-rs/load": "^0.1.82"
53
53
  },
54
54
  "optionalDependencies": {
55
- "@cipherstash/protect-ffi-win32-x64-msvc": "0.9.0",
56
- "@cipherstash/protect-ffi-darwin-x64": "0.9.0",
57
- "@cipherstash/protect-ffi-darwin-arm64": "0.9.0",
58
- "@cipherstash/protect-ffi-linux-x64-gnu": "0.9.0",
59
- "@cipherstash/protect-ffi-linux-arm64-gnu": "0.9.0"
55
+ "@cipherstash/protect-ffi-win32-x64-msvc": "0.10.0",
56
+ "@cipherstash/protect-ffi-darwin-x64": "0.10.0",
57
+ "@cipherstash/protect-ffi-darwin-arm64": "0.10.0",
58
+ "@cipherstash/protect-ffi-linux-x64-gnu": "0.10.0",
59
+ "@cipherstash/protect-ffi-linux-arm64-gnu": "0.10.0"
60
60
  }
61
61
  }