diff --git a/README.md b/README.md index 39e478b..bc646ff 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,41 @@ -# Obsidian Encrypt Plugin +# [Meld Encrypt](https://github.com/meld-cp/obsidian-encrypt) Plugin for Obsidian -**Create encrypted notes within your [Obsidian.md](https://obsidian.md/) vault.** +**Create Encrypted Notes Within Your [Obsidian.md](https://obsidian.md/) Vault** + +[Meld Encrypt](https://github.com/meld-cp/obsidian-encrypt) is a community plugin that lets you encrypt and decrypt your notes in [Obsidian](https://obsidian.md/). You can choose to encrypt an [entire note](https://meld-cp.github.io/obsidian-encrypt/whole-encrypted-notes.html) or just [selected text within a note](https://meld-cp.github.io/obsidian-encrypt/in-place-encryption.html). Encrypted notes are never decrypted to disk giving you peace-of-mind that the decrypted contents haven't been sync'd or backed up to external systems. +--- + +> [!WARNING] +> ⚠️ Use at Your Own Risk ⚠️ +> - Your passwords are never stored. If you forget your password, your notes cannot be decrypted.. +> - The encryption methods used have not been independently audited. Unauthorized access may be possible if someone gains access to your files. +> - Bugs may be introduced at any time. You are solely responsible for maintaining backups of your notes. + +--- + +## Ongoing Maintenance and Development -> ⚠️ WARNING - Use at your own risk ⚠️ -> - Your passwords are never stored anywhere, if you forget your passwords you can't decrypt your notes. -> - No known audits have been undertaken for the soundness of encryption methods being used. Unwanted decryption by a 3rd party may be possible if they have access to your files. -> - Bugs could be introduced to the software at anytime, you are responsible for having backups of your notes. +If you find this plugin useful please support the ongoing maintenance and development by: +* [Staring ⭐ this repo](https://github.com/meld-cp/obsidian-encrypt) +* [Buying me a coffee ☕](https://www.buymeacoffee.com/cleon) +* [Sponsoring ❤️ me](https://github.com/sponsors/meld-cp). +Thank you for your support 😊 -## ⚜️ Latest Changes +Buy Me A Coffee -Buy Me A Coffee -Please visit the [Change Log](https://github.com/meld-cp/obsidian-encrypt/blob/main/CHANGELOG.md) for a listing of changes. +## Latest Changes -Report any bugs or feature requests [here](https://github.com/meld-cp/obsidian-encrypt/issues). +Information about the latest release can be found on the [release notes](https://meld-cp.github.io/obsidian-encrypt/release-notes.html) page. -## ⚜️ Documentation +Report any bugs or features requests [here](https://github.com/meld-cp/obsidian-encrypt/issues). + + +## Documentation Documentation can be found [here](https://meld-cp.github.io/obsidian-encrypt/) + diff --git a/docs/index.md b/docs/index.md index 808bf77..6727346 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,24 +4,38 @@ layout: default nav_order: 1 --- -# Obsidian Encrypt +# [Meld Encrypt](https://github.com/meld-cp/obsidian-encrypt) Plugin for Obsidian -## Create Encrypted Notes Within Your [Obsidian.md](https://obsidian.md/) Vault +**Create Encrypted Notes Within Your [Obsidian.md](https://obsidian.md/) Vault** -Obsidian Encrypt is a community plugin that lets you encrypt and decrypt your notes in Obsidian. You can choose to encrypt an entire note or just selected text within a note. +[Meld Encrypt](https://github.com/meld-cp/obsidian-encrypt) is a community plugin that lets you encrypt and decrypt your notes in [Obsidian](https://obsidian.md/). You can choose to encrypt an [entire note](https://meld-cp.github.io/obsidian-encrypt/whole-encrypted-notes.html) or just [selected text within a note](https://meld-cp.github.io/obsidian-encrypt/in-place-encryption.html). Encrypted notes are never decrypted to disk giving you peace-of-mind that the decrypted contents haven't been sync'd or backed up to external systems. -> ⚠️ WARNING - Use at Your Own Risk ⚠️ +--- + +> [!WARNING] +> ⚠️ Use at Your Own Risk ⚠️ > - Your passwords are never stored. If you forget your password, your notes cannot be decrypted.. > - The encryption methods used have not been independently audited. Unauthorized access may be possible if someone gains access to your files. > - Bugs may be introduced at any time. You are solely responsible for maintaining backups of your notes. -Do you find this plugin useful? You can support further development by buying me a coffee: +--- + +## Ongoing Maintenance and Development -Buy Me A Coffee +If you find this plugin useful please support the ongoing maintenance and development by: +* [Staring ⭐ this repo](https://github.com/meld-cp/obsidian-encrypt) +* [Buying me a coffee ☕](https://www.buymeacoffee.com/cleon) +* [Sponsoring ❤️ me](https://github.com/sponsors/meld-cp). Thank you for your support 😊 -Report any bugs or feature requests [here](https://github.com/meld-cp/obsidian-encrypt/issues). +Buy Me A Coffee + + +## Latest Changes + +Information about the latest release can be found on the [release notes](https://meld-cp.github.io/obsidian-encrypt/release-notes.html) page. +Report any bugs or features requests [here](https://github.com/meld-cp/obsidian-encrypt/issues).