cert-signer.git

commit 80949bb6a89e7eca8edde909c4bb1d5d22e7e07a

Author: Paolo Lulli <paolo@lulli.net>

Added minimal instructions

 README.md | 40 ++++++++++++++++++++++++++++++++++++++++


diff --git a/README.md b/README.md
index 1bfeefa53ec6ec60d64a62bc4cfd2027884cb702..8d16979c6615d30c505db67fb928cc901d5524c4 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,43 @@
 # Cert-Signer
 
 A Private CA implementation library
+
+## What it this
+
+This is a Java library that implements a Private CA, able to sign certificates for client of services within your organization.
+
+It is meant to be used to create client certificate for mTLS authentication of private services within your network.
+
+## Special features
+
+Certificate Authority and client certificates are generated and stored via a **VaultSigningStrategy** on a Hashicorp Vault instance.
+
+## Build the library
+
+```
+cd cert-signer
+mvn clean install
+```
+
+
+## Initialize the CA:
+
+
+You should have a Vault instance running, and you should create the following config file: **~/.vault-credentials.cfg**
+with the following environment defined:
+
+```
+export VAULT_ENDPOINT="https://<my-address>/<custom-path>"
+export VAULT_TOKEN="hvs.XXXXXXXXXXXXXXXX"
+```
+
+To initialize a custom CA for *my-service**
+
+```
+cd cert-signer
+./script/initializeCA my-service
+``` 
+
+## License
+
+see: [COPYING](./COPYING)