From e55719c128eb2730feb523616ae89e9c35e078b4 Mon Sep 17 00:00:00 2001
From: oluceps <secinia@outlook.com>
Date: Sun, 3 Nov 2024 22:23:59 +0800
Subject: [PATCH] +

---
 README.md | 46 +++++++---------------------------------------
 1 file changed, 7 insertions(+), 39 deletions(-)

diff --git a/README.md b/README.md
index a5d7bad..58367db 100644
--- a/README.md
+++ b/README.md
@@ -1,55 +1,23 @@
 # Vaultix
 
-Secret management for NixOS. Subset replacement of agenix.
+Secret management for NixOS.
 
-Highly inspired by agenix-rekey.
+Highly inspired by agenix-rekey. Based on rust age crate.
 
 > [!CAUTION]
 > This project is in early dev stage, NOT ready for production.
 
-## Known Issue
-
-secret edited but not renc yet, vaultix calculate the path from `file` and get from store path,
-
-at this moment the path `storageDirStore` exist on store but the renced secret not. app will crash.
-
-## Target
-
-+ Less Bash
-+ Parallel Encryption / Decryption
 + AGE Key Support
-+ PIV Card Support
-+ **No** GPG Support
-
-### Support platforms:
-
-```nix
-systems = [
-  "x86_64-linux"
-  "aarch64-linux"
-];
-```
++ PIV Card (Yubikey) Support
 
 ## Usage
 
 Prerequisite:
 
-+ using flake.
-
-+ using nix-command feature
-
-+ using flake-parts.
-
-+ pass `self` as specialArgs, to `nixosSystem`.
-
++ flake.
 
-## Compatibilities
++ nix-command feature enabled
 
-(Will) Inherited Options:
++ flake-parts.
 
-```
-config.age.identityPaths      # /persist/keys/ssh_host_ed25519_key
-config.age.secrets
-config.age.secretsDir         # /run/vaultix
-config.age.secretsMountPoint  # /run/vaultix.d
-```
++ `self` as specialArgs, to `nixosSystem`.