summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTomSweeneyRedHat <tsweeney@redhat.com>2019-10-02 10:25:38 -0400
committerTomSweeneyRedHat <tsweeney@redhat.com>2019-10-02 10:25:42 -0400
commit5f932fa441a64a8fa0f75cb848a9a2079c770a43 (patch)
tree717342118465c8ec566a833b0ec65dfb65add985
parent257a985f5a7cff8f01891529ea89b0ea2800d61f (diff)
downloadpodman-5f932fa441a64a8fa0f75cb848a9a2079c770a43.tar.gz
podman-5f932fa441a64a8fa0f75cb848a9a2079c770a43.tar.bz2
podman-5f932fa441a64a8fa0f75cb848a9a2079c770a43.zip
Add api link to tutorials
We recently moved the "How to use libpod for custom/derivative projects" page to the docs/tutorials directory. This adds a link to the README.md there so it can be more easily found and adds a logo to the tutorial itself. Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
-rw-r--r--docs/tutorials/README.md4
-rw-r--r--docs/tutorials/podman-derivative-api.md4
2 files changed, 7 insertions, 1 deletions
diff --git a/docs/tutorials/README.md b/docs/tutorials/README.md
index 2cf9613b6..bcd1b01d9 100644
--- a/docs/tutorials/README.md
+++ b/docs/tutorials/README.md
@@ -19,3 +19,7 @@ Special setup for running the Podman remote client on a Mac and connecting to Po
**[Remote Client](remote_client.md)**
A brief how-to on using the Podman remote-client.
+
+**[How to use libpod for custom/derivative projects](podman-derivative-api.md)**
+
+How the libpod API can be used within your own project.
diff --git a/docs/tutorials/podman-derivative-api.md b/docs/tutorials/podman-derivative-api.md
index 0342bb740..065b0c4a9 100644
--- a/docs/tutorials/podman-derivative-api.md
+++ b/docs/tutorials/podman-derivative-api.md
@@ -1,3 +1,5 @@
+![PODMAN logo](../../logo/podman-logo-source.svg)
+
# How to use libpod for custom/derivative projects
libpod today is a Golang library and a CLI. The choice of interface you make has advantages and disadvantages.
@@ -41,4 +43,4 @@ Making the choice
A good question to ask first is: Do you want users to be able to use `podman` to manipulate the containers created by your project?
If so, that makes it more likely that you want to run `podman` as a subprocess. If you want a separate image store and a fundamentally
different experience; if what you're doing with containers is quite different from those created by the `podman` CLI,
-that may drive you towards vendoring. \ No newline at end of file
+that may drive you towards vendoring.