From 43e792b10cb0037e317b8a28d04395d8578cbe47 Mon Sep 17 00:00:00 2001
From: Felix Fontein <felix@fontein.de>
Date: Wed, 1 Apr 2020 15:17:37 +0200
Subject: [PATCH] Add proper README and update COPYING (#10)

* Add proper README and update COPYING.

* Update README.md

Co-Authored-By: Andrea Tartaglia <andrea@braingap.uk>

* Update README.md

Co-Authored-By: Andrea Tartaglia <andrea@braingap.uk>

* Update title.

* Mention that collection is also tested with Ansible 2.9.

Co-authored-by: Andrea Tartaglia <andrea@braingap.uk>
---
 COPYING   |  9 +++---
 README.md | 92 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 93 insertions(+), 8 deletions(-)

diff --git a/COPYING b/COPYING
index 10926e87..f288702d 100644
--- a/COPYING
+++ b/COPYING
@@ -1,7 +1,7 @@
                     GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
@@ -645,7 +645,7 @@ the "copyright" line and a pointer to where the full notice is found.
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
@@ -664,12 +664,11 @@ might be different; for a GUI interface, you would use an "about box".
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
+<https://www.gnu.org/licenses/>.
 
   The GNU General Public License does not permit incorporating your program
 into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
-
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
diff --git a/README.md b/README.md
index 10aefcd0..6934d925 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,90 @@
-[![GitHub Actions CI/CD build status — Collection test suite](https://github.com/ansible-collection-migration/community.crypto/workflows/Collection%20test%20suite/badge.svg?branch=master)](https://github.com/ansible-collection-migration/community.crypto/actions?query=workflow%3A%22Collection%20test%20suite%22)
+# Ansible Community Crypto Collection
+[![Shippable build status](https://api.shippable.com/projects/5e66776ca27f990007073a42/badge?branch=master)](https://app.shippable.com/projects/5e66776ca27f990007073a42)
+[![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/community.crypto)](https://codecov.io/gh/ansible-collections/community.crypto)
 
-Ansible Collection: community.crypto
-=================================================
\ No newline at end of file
+Provides modules for [Ansible](https://www.ansible.com/community) for various cryptographic operations.
+
+<!-- Describe the collection and why a user would want to use it. What does the collection do? -->
+
+## Tested with Ansible
+
+Tested with both the current Ansible 2.9 release and the current development version of Ansible.
+
+<!-- List the versions of Ansible the collection has been tested with. Must match what is in galaxy.yml. -->
+
+## External requirements
+
+The exact requirements for every module are listed in the module documentation. 
+Most modules require a recent enough version of [the Python cryptography library](https://pypi.org/project/cryptography/). See the module documentations for the minimal version supported for each module.
+
+## Included content
+
+- OpenSSL / PKI modules:
+  - openssl_certificate_info
+  - openssl_certificate
+  - openssl_csr_info
+  - openssl_csr
+  - openssl_dhparam
+  - openssl_pkcs12
+  - openssl_privatekey_info
+  - openssl_privatekey
+  - openssl_publickey
+  - x509_crl_info
+  - x509_crl
+  - certificate_complete_chain
+- OpenSSH modules:
+  - openssh_cert
+  - openssh_keypair
+- ACME modules:
+  - acme_account_info
+  - acme_account
+  - acme_certificate
+  - acme_certificate_revoke
+  - acme_challenge_cert_helper
+  - acme_inspect
+- ECS modules:
+  - ecs_certificate
+  - ecs_domain
+- Miscellaneous modules:
+  - get_certificate
+  - luks_device
+
+## Using this collection
+
+<!--Include some quick examples that cover the most common use cases for your collection content. -->
+
+See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.
+
+## Contributing to this collection
+
+<!--Describe how the community can contribute to your collection. At a minimum, include how and where users can create issues to report problems or request features for this collection.  List contribution requirements, including preferred workflows and necessary testing, so you can benefit from community PRs. If you are following general Ansible contributor guidelines, you can link to - [Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html). -->
+
+We're following the general Ansible contributor guidelines; see [Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html).
+
+If you want to clone this repositority (or a fork of it) to improve it, you can proceed as follows:
+1. Create a directory `ansible_collections/community`;
+2. In there, checkout this repository (or a fork) as `crypto`;
+3. Add the directory containing `ansible_collections` to your [ANSIBLE_COLLECTIONS_PATHS](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths).
+
+## Release notes
+
+<!--Add a link to a changelog.md file or an external docsite to cover this information. -->
+
+## Roadmap
+
+<!-- Optional. Include the roadmap for this collection, and the proposed release/versioning strategy so users can anticipate the upgrade/update cycle. -->
+
+## More information
+
+<!-- List out where the user can find additional information, such as working group meeting times, slack/IRC channels, or documentation for the product this collection automates. At a minimum, link to: -->
+
+- [Ansible Collection overview](https://github.com/ansible-collections/overview)
+- [Ansible User guide](https://docs.ansible.com/ansible/latest/user_guide/index.html)
+- [Ansible Developer guide](https://docs.ansible.com/ansible/latest/dev_guide/index.html)
+- [Ansible Community code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html)
+
+## Licensing
+
+GNU General Public License v3.0 or later.
+
+See [COPYING](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.