mdenc 0.1.3 → 2.0.0

package/README.md

@@ -2,6 +2,8 @@
 
 **Encrypt your Markdown. Keep your diffs.**
 
+[**Live Demo**](https://yogh-io.github.io/mdenc/) | [npm](https://www.npmjs.com/package/mdenc) | [Specification](SPECIFICATION.md) | [Security](SECURITY.md)
+
 mdenc lets you store encrypted Markdown in git without losing the ability to see *what changed*. Edit one paragraph, and only that paragraph changes in the encrypted output. Your `git log` stays useful. Your pull request reviews stay sane.
 
 ## What it looks like
@@ -92,29 +94,26 @@ Password is read from `MDENC_PASSWORD` env var or prompted interactively (no ech
 
 ## Git Integration
 
-mdenc can automatically encrypt and decrypt files as part of your git workflow.
+mdenc uses git's native **smudge/clean filter** to transparently encrypt and decrypt `.md` files. You edit plaintext locally; git stores ciphertext in the repository.
 
 ```bash
-# Set up git hooks (pre-commit, post-checkout, post-merge, post-rewrite)
+# Set up git smudge/clean filter and textconv diff
 mdenc init
 
 # Generate a random password into .mdenc-password
-mdenc genpass
+mdenc genpass [--force]
 
-# Mark a directory -- .md files inside will be encrypted on commit
+# Mark a directory -- .md files inside will be filtered
 mdenc mark docs/private
 
-# See which files need encryption/decryption
+# See which files are configured for encryption
 mdenc status
 
-# Watch for changes and encrypt on save
-mdenc watch
-
-# Remove mdenc hooks from the repository
-mdenc remove-hooks
+# Remove git filter configuration
+mdenc remove-filter
 ```
 
-After `mdenc init` and `mdenc mark`, the workflow is automatic: edit `.md` files normally, and the pre-commit hook encrypts them to `.mdenc` before each commit. Post-checkout and post-merge hooks decrypt them back after switching branches or pulling.
+After `mdenc init` and `mdenc mark`, the workflow is transparent: the **clean filter** encrypts `.md` files when they're staged (`git add`), and the **smudge filter** decrypts them on checkout. You always see plaintext in your working directory. The custom diff driver shows plaintext diffs of encrypted content.
 
 ## Library