aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDavid Elentok <3david@gmail.com>2025-05-06 22:04:23 +0300
committerGitHub <noreply@github.com>2025-05-06 22:04:23 +0300
commit363e1d924c6235ae4e9170b1e2ebab50a2e26c07 (patch)
treebf21093fa70c8ed8014e70f4841714d622ec651e /README.md
parent09d7f6ee9ee1d728449131dff4e750e5339f7968 (diff)
parenta9e7d700eb546800e3d341bc53667964ac821a38 (diff)
downloadencrypt.nvim-363e1d924c6235ae4e9170b1e2ebab50a2e26c07.tar.gz
Merge pull request #2 from kongjun18/main
Some Improvement
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/README.md b/README.md
index ece988b..cac1b86 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,7 @@ in an encrypted format on the disk.
## Usage
+Encryption:
1. Open a file
2. Run `:X`
3. Enter a password
@@ -15,6 +16,13 @@ in an encrypted format on the disk.
Now the file is encrypted and every time you open it you'll be asked for the
password.
+Decryption:
+1. Open an encrypted file
+2. Run `:X`
+3. Enter a password
+
+Now the encrypted file is decrypted in the buffer.
+
## Installation
Add the following to your package manager:
@@ -35,8 +43,3 @@ tail -n +2 encrypted.txt \
```
Or use the provided [decrypt.sh](decrypt.sh)
-
-## TODO
-
-- [ ] Store the password in a local scope in the plugin instead of as a buffer
- variable.