feat: update readme
This commit is contained in:
28
README.md
28
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 <file-name> <algorithm> <key-hex> <nonce-hex>
|
||||
|
||||
> `<algorithm>` is always `aes-256-gcm`<br>
|
||||
> Exit `0` when success, otherwise return none `0`
|
||||
|
||||
Export:
|
||||
```shell
|
||||
export SECURE_EDITOR=/REAL-PATH/secure-editor-rs
|
||||
```
|
||||
|
||||
@@ -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
|
||||
```
|
||||
Reference in New Issue
Block a user