Skip to content

Commit 69a8314

Browse files
committed
chore: update readme
1 parent 9090b28 commit 69a8314

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ As you configured the provider, you may now create your first credentials by run
107107
# ---
108108
# Flags
109109
# --env string Specify an environment for credentials file (default: development)
110-
# --content string Specify initial content for credentials file (default: { "hello": "world" })
110+
# --format string Specify format for the credentials file (default: yaml, available: json,yaml)
111111

112112
node ace credentials:create
113113
```
@@ -170,8 +170,9 @@ For production you should set additional environment variable `APP_CREDENTIALS_K
170170

171171
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.
172172

173-
Credentials while decrypted present themselves as simple JSON objects, this allows to keep variables in a very predictable and simple manner:
173+
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:
174174

175+
**JSON**
175176
```json
176177
{
177178
"google": {
@@ -181,6 +182,13 @@ Credentials while decrypted present themselves as simple JSON objects, this allo
181182
}
182183
```
183184

185+
**YAML**
186+
```yaml
187+
google:
188+
key: "your_google_key"
189+
secret: "your_google_secret"
190+
```
191+
184192
Which then is being transformed to something like this:
185193
186194
```

0 commit comments

Comments
 (0)