From 08cb6e27bceb9067c0770d9ec4ea0081c8ce0ce9 Mon Sep 17 00:00:00 2001
From: Adora Laura Kalb <adora@lila.network>
Date: Fri, 12 Jul 2024 14:31:47 +0200
Subject: [PATCH] update readme

---
 README.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 73 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 24aa528..2dbbcda 100644
--- a/README.md
+++ b/README.md
@@ -2,10 +2,81 @@
 ![status-badge](https://ci.lila.network/api/badges/22/status.svg)
 [![Please don't upload to GitHub](https://nogithub.codeberg.page/badge.svg)](https://nogithub.codeberg.page)
 
-This is a tool to deploy certificates from a [CertWarden](https://www.certwarden.com/) instance.
+This is a simple binary to deploy certificates from a [CertWarden](https://www.certwarden.com/) instance.
+
+## Quick Start
+
+Installation of the required CertWarden instance is out of scope of this documentation. For detailed instructions regarding CertWarden, please visit [it's documentation](https://www.certwarden.com/docs/introduction/)
+
+
+To quickly get started with `certwarden-deploy`, just download the binary...
+
+```shell
+# this downloads certwarden-deploy version 0.1.1 
+# to /usr/local/bin/certwarden-deploy
+sudo wget https://code.lila.network/adoralaura/certwarden-deploy/releases/download/0.1.1/certwarden-deploy-0.1.1-linux-amd64 -O /usr/local/bin/certwarden-deploy
+
+sudo chmod +x /usr/local/bin/certwarden-deploy
+```
+
+... fill out the config file...
+```shell
+vi /etc/certwarden-deploy/config.yaml
+```
+```yaml
+# Base URL of the CertWarden instance
+# required
+base_url: "https://certwarden.example.com"
+
+# Set this to true if your CertWarden instance does not have a publicly trusted 
+# TLS certificate (e.g. it has a self signed one)
+# default is false
+disable_certificate_validation: false
+
+# define all managed certificates here
+certificates:
+
+    # name is a unique identifier that must start and end with an alphanumeric character, 
+    # and can contain the following characters: a-zA-Z0-9._-
+    # required
+  - name: test-certificate.example.com
+
+    # Contains the API-Key to fetch the certificate from the server
+    # required
+
+    api_key: examplekey_notvalid_hrzjGDDw8z
+
+    # action to run when certificate was updated or --force is on
+    action: "/usr/bin/systemd reload caddy"
+
+    # path where to save the certificate
+    # required
+    file_path: "/path/to/test-certificate.example.com-cert.pem"
+```
+
+... and run it!
+```shell
+certwarden-deploy -v
+```
+## Contributing
+
+I use my own [Forgejo Instance](https://code.lila.network) to manage issues and pull requests.
+
+* If you have a trivial fix or improvement, go ahead and create a pull request,
+  addressing (with `@...`) the maintainer of this repository (see
+  [MAINTAINERS.md](MAINTAINERS.md)) in the description of the pull request.
+
+* If you plan to do something more involved, first please [send me a mail]( mailto:adora@lila.network?subject=%5Bcertwarden-deploy%5D).
+
+### What to contribute
+
+The best way to help without speaking a lot of Go would be to share your
+configuration, alerts, dashboards, and recording rules. If you have something
+that works and is not in the repository, please pay it forward and
+share what works.
 
 ## Changelog
 You can find the Changelog here: [Changelog](https://code.lila.network/adoralaura/certwarden-deploy/src/branch/main/CHANGELOG.md)
 
 ## License
-`certwarden-deploy` is available under the MIT license. See the LICENSE file for more info.
+`certwarden-deploy` is available under the MIT license. See the [LICENSE](https://code.lila.network/adoralaura/certwarden-deploy/src/branch/main/LICENSE) file for more info.