Skip to content

Commit

Permalink
various docs touch-ups
Browse files Browse the repository at this point in the history
- add language hints to examples to enable highlighting on GitHub.
- remove "binary release" instructions, because current releases
  have not released binaries.
- updated `go install` instructions for go modules (add `@latest`).
- fixed link to original github repository.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
  • Loading branch information
thaJeztah committed Aug 26, 2021
1 parent 3f0829a commit fe3aa47
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 20 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# crypt

**This is a maintained fork of the abandoned [original](https://github.com/bketelsen/crypt)**
**This is a maintained fork of the abandoned [original](https://github.com/xordataexchange/crypt)**

You can use crypt as a command line tool or as a configuration library:

Expand All @@ -19,7 +19,7 @@ The crypt cli and config package require gpg keyrings.

### Create a key and keyring from a batch file

```
```bash
vim app.batch
```

Expand All @@ -39,7 +39,7 @@ Expire-Date: 0

Run the following command:

```
```bash
gpg2 --batch --armor --gen-key app.batch
```

Expand Down
22 changes: 7 additions & 15 deletions bin/crypt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,8 @@

## Install

### Binary release

```
wget https://github.com/bketelsen/crypt/releases/download/v0.0.1/crypt-0.0.1-linux-amd64
mv crypt-0.0.1-linux-amd64 /usr/local/bin/crypt
chmod +x /usr/local/bin/crypt
```

### go install

```
go install github.com/bketelsen/crypt/bin/crypt
```bash
go install github.com/bketelsen/crypt/bin/crypt@latest
```

## Backends
Expand Down Expand Up @@ -41,7 +31,7 @@ usage: crypt set [args...] key file

Example:

```
```bash
crypt set -keyring pubring.gpg /app/config config.json
```

Expand All @@ -56,15 +46,17 @@ usage: crypt get [args...] key

Example:

```
```bash
crypt get -secret-keyring secring.gpg /app/config
```

### Support for unencrypted values
```

```bash
crypt set -plaintext ...
crypt get -plaintext ...
```

Crypt now has support for getting and setting plain unencrypted values, as
a convenience. This was added to the backend libraries so it could be exposed
in spf13/viper. Use the -plaintext flag to get or set a value without encryption.
4 changes: 2 additions & 2 deletions config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

### Get configuration from a backend

```
```go
package main

import (
Expand Down Expand Up @@ -41,7 +41,7 @@ func main() {

### Monitor backend for configuration changes

```
```go
package main

import (
Expand Down

0 comments on commit fe3aa47

Please sign in to comment.