@dotenvx/next-env 2.5.5 → 3.0.0

package/README.md

@@ -23,15 +23,42 @@ npm run dev
 npm run build
 ```
 
-## Third Party Notices
+## Native loader
+
+The Node addon uses the same Rust SDK as dotenvx for Ruby and Python. It loads
+keys from the environment or `.env.keys` and can delegate missing keys to
+`dotenvx sdk keyring` when a compatible dotenvx CLI is on `PATH`.
+
+To build the addon for your current platform from the Forge checkout, install
+the Rust toolchain and run:
+
+```sh
+npm ci --prefix next-env
+npm run test:next-env
+```
 
-This package bundles portions of `@dotenvx/primitives`, which bundles portions of the following MIT-licensed packages:
+## Releases
 
-- `eciesjs`
-- `@ecies/ciphers`
-- `@noble/curves`
-- `@noble/hashes`
-- `@noble/ciphers`
+From a clean Forge checkout, run `npm run version:batch -- next-env major`
+to bump the npm and Cargo versions, commit the bump, and create a matching
+`next-env-vX.Y.Z` tag. Add `--push` on `main` to push the commit and tag and
+trigger `.github/workflows/next-env.yml`. Use `minor` or `patch` for those bumps.
+
+The workflow ships one npm tarball with addons for macOS arm64/x64,
+Linux glibc arm64/x64, and Windows x64. Consumers install it with npm
+without a Rust toolchain.
+
+In the npm settings for `@dotenvx/next-env`, add a GitHub Actions trusted publisher:
+
+| Field | Value |
+| --- | --- |
+| Organization | `dotenvx` |
+| Repository | `forge` |
+| Workflow filename | `next-env.yml` |
+| Environment | `release` |
+| Allowed action | `npm publish` |
+
+## Third Party Notices
 
 ### eciesjs