feat: card-cryptmator plugin

README.md

@@ -1,2 +1,58 @@
-# card-cryptomator
+# tinyencrypt-cryptomator
 
+> This project is fork from https://github.com/purejava/keepassxc-cryptomator , add GnuPG support
+
+[![GitHub Release](https://img.shields.io/github/v/release/jht5945/gnupg-cryptomator)](https://github.com/jht5945/gnupg-cryptomator/releases)
+[![License](https://img.shields.io/github/license/jht5945/gnupg-cryptomator.svg)](https://github.com/jht5945/gnupg-cryptomator/blob/master/LICENSE)
+
+Plug-in for Cryptomator to store vault passwords with card-cli encryption.
+
+# Build Project
+
+Requirement:
+
+* JDK 17 or later
+* Maven 3.8.4 or later
+
+```shell
+mvn package
+```
+
+Copy packaged plugin from `target/card-cryptomator-$VERSION.jar` to Cryptomator plugins directory.
+> Usage reference [Wiki](https://github.com/purejava/keepassxc-cryptomator/wiki)
+
+# Configuration
+
+Configure file location:
+
+* `/etc/cryptomator/card_config.json`
+* `~/.config/cryptomator/card_config.json`
+
+```json
+{
+}
+```
+
+# Documentation
+
+For documentation please take a look at the [Wiki](https://github.com/purejava/keepassxc-cryptomator/wiki).
+
+Plugin location:
+
+| OS | Default Dir |
+| ---- | ---- |
+| Mac | `~/Library/Application Support/Cryptomator/Plugins` |
+| Linux | `~/.local/share/Cryptomator/plugins` |
+| Windows | `%homepath%\AppData\Roaming\Cryptomator\Plugins` |
+
+# How it works?
+
+This plugin use card-cli encrypt and decrypt passwords.
+
+# Copyright
+
+Copyright (C) 2021-2024 Ralph Plawetzki<br>
+Copyright (C) 2024-2024 Hatter Jiang
+
+The Cryptomator logo is Copyright (C) of https://cryptomator.org/ <br>
+The KeePassXC logo is Copyright (C) of https://keepassxc.org/