chore: Adds lots of documentation.

This commit is contained in:
greysoh 2024-10-19 18:06:49 -04:00
parent 514ccee264
commit 8eb9bb3cee
Signed by: imterah
GPG key ID: 8FA7DD57BA6CEA37
11 changed files with 101 additions and 14 deletions

View file

@ -1,3 +1,24 @@
# Bismuth Protocol
The Bismuth protocol is a thin wrapper for any protocol that adds TLS-like features, without being TLS on its own.
## Application
### Building
Git clone this repository and check out a release (except for development, as you probably don't wanna develop on a release version):
```bash
git clone https://git.greysoh.dev/imterah/bismuthd
git checkout v0.1.0
```
Then, build the code:
```bash
go build .
```
### Usage
To get started, you'll need an exported armored public and private key pair.
After that, for usage help, run the help command:
```
./bismuthd help
```