From c7b0376e3493cf5146075f8456850aabfb94147f Mon Sep 17 00:00:00 2001 From: Hatter Jiang Date: Wed, 21 Aug 2024 01:07:52 +0800 Subject: [PATCH] feat: update readme --- README.md | 28 +++++++++++++++++++++++++++- src-tauri/README.md | 23 ----------------------- 2 files changed, 27 insertions(+), 24 deletions(-) delete mode 100644 src-tauri/README.md diff --git a/README.md b/README.md index 65dc5e9..d7622b5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,28 @@ # secure-editor-rs -Secure Editor Rust edition +Secure Editor written in Rust Programming Language. +## Preparation + +```shell +cargo install create-tauri-app --locked +``` + +## Build + +### Development Build + +```shell +just dev +``` + +### Release Build + +```shell +just build +``` + +## Usage Command line: ```shell @@ -10,3 +31,8 @@ secure-editor-rs > `` is always `aes-256-gcm`
> Exit `0` when success, otherwise return none `0` + +Export: +```shell +export SECURE_EDITOR=/REAL-PATH/secure-editor-rs +``` diff --git a/src-tauri/README.md b/src-tauri/README.md deleted file mode 100644 index 6ef8f55..0000000 --- a/src-tauri/README.md +++ /dev/null @@ -1,23 +0,0 @@ -# Secure Editor Rust Edition - -Secure Editor written in Rust Programming Language. - -## Preparation - -```shell -cargo install create-tauri-app --locked -``` - -## Build - -### Development Build - -```shell -just dev -``` - -### Release Build - -```shell -just build -``` \ No newline at end of file