Version v0.3.33 - Update readme.md some more
This commit is contained in:
53
README.md
53
README.md
@@ -58,33 +58,36 @@ One-time pads can be trivially encrypted and decrypted using pencil and paper, m
|
||||
|
||||
### Download Pre-Built Binaries
|
||||
|
||||
**[Download Current Linux x86](https://git.laantungir.net/laantungir/otp/releases/download/v0.3.31/otp-v0.3.31-linux-x86_64)**
|
||||
**[Download Current Linux x86](https://git.laantungir.net/laantungir/otp/releases/download/v0.3.32/otp-v0.3.32-linux-x86_64)**
|
||||
|
||||
**[Download Current Raspberry Pi 64](https://git.laantungir.net/laantungir/otp/releases/download/v0.3.31/otp-v0.3.31-linux-arm64)**
|
||||
**[Download Current Raspberry Pi 64](https://git.laantungir.net/laantungir/otp/releases/download/v0.3.32/otp-v0.3.32-linux-arm64)**
|
||||
|
||||
After downloading:
|
||||
```bash
|
||||
# Make executable and run
|
||||
chmod +x otp-v0.3.31-linux-x86_64
|
||||
./otp-v0.3.31-linux-x86_64
|
||||
# Make executable and rename for convenience
|
||||
chmod +x otp-v0.3.32-linux-x86_64
|
||||
mv otp-v0.3.32-linux-x86_64 otp
|
||||
|
||||
# Run it
|
||||
./otp
|
||||
```
|
||||
|
||||
### First Steps
|
||||
|
||||
1. **Generate your first pad:**
|
||||
```bash
|
||||
./otp-v0.3.31-linux-x86_64 generate 1GB
|
||||
./otp generate 1GB
|
||||
```
|
||||
|
||||
2. **Encrypt a message:**
|
||||
```bash
|
||||
./otp-v0.3.31-linux-x86_64 encrypt
|
||||
./otp encrypt
|
||||
# Follow the interactive prompts
|
||||
```
|
||||
|
||||
3. **Decrypt a message:**
|
||||
```bash
|
||||
./otp-v0.3.31-linux-x86_64 decrypt
|
||||
./otp decrypt
|
||||
# Paste the encrypted message
|
||||
```
|
||||
|
||||
@@ -121,28 +124,38 @@ After building, run with:
|
||||
|
||||
## Usage
|
||||
|
||||
### Interactive Mode
|
||||
```bash
|
||||
# If you downloaded the binary:
|
||||
./otp-v0.3.31-linux-x86_64
|
||||
The OTP Cipher operates in two modes:
|
||||
|
||||
# If you built from source:
|
||||
./build/otp-x86_64
|
||||
**Interactive Mode**: Run without arguments to access a menu-driven interface. Best for exploring features, managing pads, and performing operations step-by-step with prompts and guidance.
|
||||
|
||||
**Command Line Mode**: Provide arguments to execute specific operations directly. Ideal for scripting, automation, and quick one-off tasks.
|
||||
|
||||
### Interactive Mode
|
||||
|
||||
Launch the menu-driven interface:
|
||||
|
||||
```bash
|
||||
./otp
|
||||
```
|
||||
|
||||
Navigate through menus to generate pads, encrypt/decrypt messages, manage pads, and configure settings.
|
||||
|
||||
### Command Line Mode
|
||||
|
||||
Execute operations directly with arguments:
|
||||
|
||||
```bash
|
||||
# Generate a new pad
|
||||
./otp-v0.3.31-linux-x86_64 generate 1GB
|
||||
./otp generate 1GB
|
||||
|
||||
# Encrypt text (interactive input)
|
||||
./otp-v0.3.31-linux-x86_64 encrypt <pad_hash_or_prefix>
|
||||
# Encrypt text (will prompt for input)
|
||||
./otp encrypt <pad_hash_or_prefix>
|
||||
|
||||
# Decrypt message (interactive input)
|
||||
./otp-v0.3.31-linux-x86_64 decrypt <pad_hash_or_prefix>
|
||||
# Decrypt message (will prompt for input)
|
||||
./otp decrypt <pad_hash_or_prefix>
|
||||
|
||||
# List available pads
|
||||
./otp-v0.3.31-linux-x86_64 list
|
||||
./otp list
|
||||
```
|
||||
|
||||
## Version System
|
||||
|
||||
Reference in New Issue
Block a user