Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bitkidd committed Sep 11, 2022
1 parent 9090b28 commit 69a8314
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ As you configured the provider, you may now create your first credentials by run
# ---
# Flags
# --env string Specify an environment for credentials file (default: development)
# --content string Specify initial content for credentials file (default: { "hello": "world" })
# --format string Specify format for the credentials file (default: yaml, available: json,yaml)

node ace credentials:create
```
Expand Down Expand Up @@ -170,8 +170,9 @@ For production you should set additional environment variable `APP_CREDENTIALS_K

The provider uses node.js' native crypto library and encrypts everything using *AES* cipher with a random vector, which makes your secrets very secure, with a single key that can decrypt data.

Credentials while decrypted present themselves as simple JSON objects, this allows to keep variables in a very predictable and simple manner:
Credentials while decrypted present themselves as simple files in JSON or YAML formats, this allows to keep variables in a very predictable and simple manner:

**JSON**
```json
{
"google": {
Expand All @@ -181,6 +182,13 @@ Credentials while decrypted present themselves as simple JSON objects, this allo
}
```

**YAML**
```yaml
google:
key: "your_google_key"
secret: "your_google_secret"
```
Which then is being transformed to something like this:
```
Expand Down

0 comments on commit 69a8314

Please sign in to comment.