Skip to content

Commit 8ac56e2

Browse files
committed
docs: 📝 update README to include heredoc example call
1 parent 38d8b20 commit 8ac56e2

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,33 @@ This project could be the answer then!
1414

1515
Write your certificate chain configuration once and create all necessary certificates when ever you need new ones!
1616

17-
## Example
17+
## Usage
18+
19+
For detailed information about the CLI run `test-certs --help`.
20+
21+
It is possible to specific the input file via the command line.
22+
The input file can either be parsed as YAML or JSON
23+
24+
`test-certs --input ./cert.yaml --out-dir ./certs yaml`
25+
26+
You can also pipe in a configuration via stdin:
27+
28+
`echo "my-client:\n type: client\n ip: 127.0.0.1\n dns_name: my-client.com" | test-certs`
29+
30+
This enables you to use heredoc to generate certificates:
31+
32+
```bash
33+
cat << EOF | test-certs
34+
my-client:
35+
type: client
36+
ip: 127.0.0.1
37+
dns_name: my-client.org
38+
EOF
39+
```
40+
41+
42+
43+
## Example Configuration
1844

1945
An example configuration file on how to create a root certificate that issues an intermediate ca which again issues a server and a client certificate.
2046

0 commit comments

Comments
 (0)