Merge pull request #471 from Mr-Sunglasses/docs/installation

docs: Add Installation and docs in README.md
containers · Nov 22, 2024 · 67aedd4 · 67aedd4
2 parents 5d3747e + f9dfcae
commit 67aedd4
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,23 @@
 This python package is a library of bindings to use the RESTful API of [Podman](https://github.com/containers/podman).
 It is currently under development and contributors are welcome!
 
+## Installation
+
+<div class="termy">
+
+```console
+pip install podman
+```
+
+</div>
+
+---
+
+**Documentation**: <a href="https://podman-py.readthedocs.io/en/latest/" target="_blank">https://podman-py.readthedocs.io/en/latest/</a>
+
+**Source Code**: <a href="https://github.com/containers/podman-py" target="_blank">https://github.com/containers/podman-py</a>
+
+---
 
 ## Dependencies