From ddd31cdf601d951f324f63e52d498654da36badd Mon Sep 17 00:00:00 2001 From: Kanishk Pachauri Date: Fri, 22 Nov 2024 23:32:33 +0530 Subject: [PATCH 1/2] docs: Add Installation and docs in README.md Signed-off-by: Kanishk Pachauri --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 1a8da562..9d75847b 100644 --- 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 + +
+ +```console +$ pip install podman +``` + +
+ +--- + +**Documentation**: https://podman-py.readthedocs.io/en/latest/ + +**Source Code**: https://github.com/containers/podman-py + +--- ## Dependencies From f9dfcae67c4028c3365afedf1ea29a400fabe642 Mon Sep 17 00:00:00 2001 From: Kanishk Pachauri Date: Fri, 22 Nov 2024 23:34:10 +0530 Subject: [PATCH 2/2] chore: Remove $ from to imporve copy. Signed-off-by: Kanishk Pachauri --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9d75847b..f2ffee71 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ It is currently under development and contributors are welcome!
```console -$ pip install podman +pip install podman ```