hatter/secure-editor-rs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: update readme

Browse Source
This commit is contained in:
Hatter Jiang
2024-08-21 01:07:52 +08:00
parent b378793dbf
commit c7b0376e34
2 changed files with 27 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -1,7 +1,28 @@
# secure-editor-rs # 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: Command line:
```shell ```shell
@@ -10,3 +31,8 @@ secure-editor-rs <file-name> <algorithm> <key-hex> <nonce-hex>
> `<algorithm>` is always `aes-256-gcm`<br> > `<algorithm>` is always `aes-256-gcm`<br>
> Exit `0` when success, otherwise return none `0` > Exit `0` when success, otherwise return none `0`
Export:
```shell
export SECURE_EDITOR=/REAL-PATH/secure-editor-rs
```

23
src-tauri/README.md
View File

@@ -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
```