Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
achoum committed Aug 9, 2024
1 parent 2ca699f commit 8b327fe
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,25 @@ A tool for encrypting a static HTML page, including its images and CSS, allowing

## Usage

Install Rustup at <https://www.rust-lang.org/tools/install> and make sure Cargo's bin is in your PATH. For example, on linux:

```shell
export PATH=$PATH:/home/$USER/.cargo/bin/
```

Then, install and run `encrypt_static_html`.

```shell
# Encrypt the page "index.html" with the password "test".
> encrypt_static_html --src=index.html --dst=index_encrypted.html --password=test
# Or, from sources:
> cargo run -- --src=index.html --dst=index_encrypted.html --password=test
cargo install --git https://github.com/achoum/encrypt_static_html
```

Given an HTML page `index.html`, encode it with:

```shel
encrypt_static_html --src=index.html --dst=index_encrypted.html --password=test
```

See `examples/encrypt.{sh,bat}` for a more complete example.
**Note:** See `examples` for a full example.

## Help

Expand Down

0 comments on commit 8b327fe

Please sign in to comment.