chore: Adds lots of documentation.
This commit is contained in:
parent
514ccee264
commit
8eb9bb3cee
11 changed files with 101 additions and 14 deletions
21
README.md
21
README.md
|
@ -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
|
||||
```
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue