yamlock 0.2.5 → 0.2.8

package/README.md

@@ -4,6 +4,9 @@
 ░░▀░░▀░▀░▀░░░▀░▀▀▀░▀▀▀░▀▀▀░▀░▀░
 ```
 
+[![npm version](https://img.shields.io/npm/v/yamlock)](https://www.npmjs.com/package/yamlock)
+[![Tests](https://img.shields.io/badge/tests-node--test-green)](https://github.com/phoenixweiss/yamlock/actions)
+
 # yamlock
 
 Value-level encryption for YAML and JSON configuration files. The name **yamlock** combines "YAML" and "lock" while also sounding like "warlock", hinting at a little configuration magic.
@@ -115,6 +118,12 @@ const restored = processConfig(processed, {
 });
 ```
 
+## Advanced usage
+
+- **Selective encryption**: combine `--paths` on the CLI or `paths: []` in `processConfig` to encrypt only sensitive sections of a config file.
+- **CI/CD flows**: see [examples/docs/ci-cd.md](examples/docs/ci-cd.md) for a GitHub Actions job that decrypts configs for builds and re-encrypts them before publishing artifacts.
+- **Key rotation**: follow [examples/docs/key-rotation.md](examples/docs/key-rotation.md) for a step-by-step process, including scripting tips for large repos.
+
 ### Supported algorithms
 
 | Algorithm | Type | Notes |
@@ -126,6 +135,11 @@ const restored = processConfig(processed, {
 
 You can also pass any algorithm supported by the current Node.js runtime (`crypto.getCiphers()`), along with custom `keyLength`, `ivLength`, or `authTagLength` overrides. Only the algorithms above are actively tested; additional presets may be added or revised in future releases.
 
+## Release information
+
+- The badges at the top show the latest npm version and the status of the Node test suite.
+- See [CHANGELOG.md](CHANGELOG.md) for detailed release notes; install a specific tag via `npm install yamlock@<version>`.
+
 ### Encrypted value format
 
 Every locked string follows the format:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yamlock",
-  "version": "0.2.5",
+  "version": "0.2.8",
   "author": "PAVEL TKACHEV (phoenixweiss) <mail@phoenixweiss.me>",
   "description": "Value-level encryption for YAML/JSON configuration files with CLI + Node.js APIs.",
   "license": "MIT",