copyright and stuff

README.md

@@ -2,14 +2,27 @@
 
 Ansible Hacky PKI is an ansible role that generate certificates signed by a given CA.
 
-The Public Certificate of the CA and its Private Key are ansible variables. Make sure to store the private key in a Vault and to not rease the CA used in example.
+## Warning
+
+You can use it to generate certificate and manage de small pki, but keep it mind that this program is distributed **WITHOUT ANY WARRANTY**.
+In particular, the **security** of the pki generated and the process of generated the pki **is not guaranteed**. If you find any vulnerability,
+please contact me to see if we can find a patch.
+
 
 ## Dependencies
 
 You need to have the `cryptography` python library available on the localhost and on the remote hosts.
 
+## How to use it
+
+Copy the roles of the repo in the role folder of your ansible projet. Define in you projet the variables you want/need to modify (cf the section Generate a CA).
+
+After that you can use the role in your playbooks, as shown in the example playbook.
+
 ## Generate a CA
 
+The Public Certificate of the CA and its Private Key are ansible variables. Make sure to store the private key in a Vault and to not rease the CA used in example.
+
 ### Generate a key
 
 ```
@@ -55,8 +68,6 @@ ca_cert: |
 
 Then, don't forget to remode the file `ca.key`.
 
-
-
 ## How does it works ?
 
 The role check if the certificate already exist and is valid. If not, it will generate **on the localhost** the certificates and then copy them to the remote host and delate the local version.
@@ -78,3 +89,7 @@ crl_distribution_points:
       - privilege_withdrawn
       - aa_compromise
 ```
+
+## Copyright
+
+Copyright 2021 Jean-Marie Mineau <histausse@protonmail.com>