doc: adds readme.

2019-02-11 05:30:51 +01:00 · 2019-02-11 05:30:51 +01:00 · ebec361b9f
commit ebec361b9f
parent 4ca0745cbd
1 changed files with 45 additions and 0 deletions
--- a/readme.md
+++ b/readme.md
@ -0,0 +1,45 @@
+# traefik-certs-dumper
+
+[![Build Status](https://travis-ci.org/ldez/traefik-certs-dumper.svg?branch=master)](https://travis-ci.org/ldez/traefik-certs-dumper)
+[![Go Report Card](https://goreportcard.com/badge/github.com/ldez/traefik-certs-dumper)](https://goreportcard.com/report/github.com/ldez/traefik-certs-dumper)
+
+
+```
+Dump the content of the "acme.json" file from Traefik to certificates.
+
+Usage:
+  traefik-certs-dumper [command]
+
+Available Commands:
+  dump        Dump Let's Encrypt certificates from Traefik
+  help        Help about any command
+  version     Display version
+
+Flags:
+  -h, --help      help for certs-dumper
+      --version   version for certs-dumper
+
+Use "traefik-certs-dumper [command] --help" for more information about a command.
+```
+
+```
+Dump the content of the "acme.json" file from Traefik to certificates.
+
+Usage:
+  traefik-certs-dumper dump [flags]
+
+Flags:
+      --dest string     Path to store the dump content. (default "./dump")
+  -h, --help            help for dump
+      --source string   Path to 'acme.json' file. (default "./acme.json")
+```
+
+## Examples
+
+```bash
+treafik-certs-dumper dump
+```
+
+```bash
+treafik-certs-dumper dump --source ./acme.json --dest ./dump
+```