diff --git a/README.md b/README.md index ee727f3..2b97205 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # ansible.posix -[![Run Status](https://api.shippable.com/projects/5e669aaf8b17a60007e4d18d/badge?branch=master)]() [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/ansible.posix)](https://codecov.io/gh/ansible-collections/ansible.posix) +[![Run Status](https://api.shippable.com/projects/5e669aaf8b17a60007e4d18d/badge?branch=master)]() @@ -18,6 +18,20 @@ None +## Installing this collection + +You can install the ``ansible.posix`` collection with the Ansible Galaxy CLI: + + ansible-galaxy collection install ansible.posix + +You can also include it in a `requirements.yml` file and install it with `ansible-galaxy collection install -r requirements.yml`, using the format: + +```yaml +--- +collections: + - name: ansible.posix +``` + ## Using this collection @@ -28,10 +42,17 @@ See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_gui +We welcome community contributions to this collection. See [Contributing to Ansible-maintained collections](https://docs.ansible.com/ansible/devel/community/contributing_maintained_collections.html#contributing-maintained-collections) for complete details. + * [Issues](https://github.com/ansible-collections/ansible.posix/issues) * [Pull Requests](https://github.com/ansible-collections/ansible.posix/pulls) * [Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html) +### Code of Conduct +This collection follows the Ansible project's +[Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html). +Please read and familiarize yourself with this document. + ## Release notes * 0.1.1 Initial stable build @@ -54,5 +75,4 @@ See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_gui GNU General Public License v3.0 or later. -See [LICENCE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text. - +See [COPYING](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.