Skip to content

Commit

Permalink
chore: add simple README files for internal extensions
Browse files Browse the repository at this point in the history
As we want to show README files of extensions, we should
have some to be displayed.

related to podman-desktop#6084

Signed-off-by: Florent Benoit <[email protected]>
  • Loading branch information
benoitf committed Mar 8, 2024
1 parent f5afd66 commit 17a359c
Show file tree
Hide file tree
Showing 7 changed files with 41 additions and 0 deletions.
3 changes: 3 additions & 0 deletions extensions/compose/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Compose Extension

The Compose Extension allows to setup compose binary so `podman compose` commands can work.
5 changes: 5 additions & 0 deletions extensions/docker/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Docker extension

Docker extension detects if docker engine is running and if running, it'll register the socket to Podman Desktop.

Then, you can monitor containers, images, volumes, etc. from Podman Desktop.
8 changes: 8 additions & 0 deletions extensions/kind/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# kind extension

This extension adds the support of https://kind.sigs.k8s.io/

By using this extension, it is possible to create kubernetes clusters
running on top of the container engine.

You can initialize a kind cluster using Settings/Resources.
5 changes: 5 additions & 0 deletions extensions/kube-context/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# kube-context extension

This extensions allows to list and switch the current kubernetes context.

It displays the contexts in the tray icon or in the status bar.
5 changes: 5 additions & 0 deletions extensions/lima/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Lima extension

This extension allows to create Lima VM used to have a podman or docker engine.

More information on Lima: https://github.com/lima-vm/lima
7 changes: 7 additions & 0 deletions extensions/podman/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Podman extension

This extension handles:

- monitor the podman machines on Linux, macOS and Windows
- creation of podman machines on macOS and Windows
- connect to the podman socket so you can see the containers, images, volumes, etc. from podman
8 changes: 8 additions & 0 deletions extensions/registries/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Registries extension

This extension registers some default registries so users don't have to
enter the full URL.

example: There is a quay.io with the icon, no need to enter `quay.io`

Only need to provide login and password when you want to connect.

0 comments on commit 17a359c

Please sign in to comment.