From 2b66eba799d6acdcc11072e5e7b9ba2152ec20c4 Mon Sep 17 00:00:00 2001
From: Sagi Shnaidman <sshnaidm@redhat.com>
Date: Mon, 30 Mar 2020 23:04:53 +0300
Subject: [PATCH] Update README

---
 README.md | 27 +++++++++++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 11eb8e9..3624ad0 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,27 @@
-[![GitHub Actions CI/CD build status — Collection test suite](https://github.com/ansible-collection-migration/containers.podman/workflows/Collection%20test%20suite/badge.svg?branch=master)](https://github.com/ansible-collection-migration/containers.podman/actions?query=workflow%3A%22Collection%20test%20suite%22)
+[![GitHub Actions CI/CD build status — Collection test suite](https://github.com/containers/ansible-podman-collections/workflows/Collection%20test%20suite/badge.svg?branch=master)](https://github.com/containers/ansible-podman-collections/actions?query=workflow%3A%22Collection%20test%20suite%22)
 
 Ansible Collection: containers.podman
-=================================================
\ No newline at end of file
+=================================================
+Basic Ansible modules for podman containers.
+
+```yaml
+- name: Run container
+  podman_container:
+    - name: web
+      state: present
+      image: ubuntu:14.04
+      command: "sleep 1d"
+```
+
+Install collection from galaxy:
+
+```bash
+ansible-galaxy collection install containers.podman
+```
+
+or clone by your own:
+
+```bash
+mkdir -p ~/.ansible/collections/ansible_collections/containers/podman/
+git clone https://github.com/containers/ansible-podman-collections.git ~/.ansible/collections/ansible_collections/containers/podman/
+```