Skip to content

Commit

Permalink
Merge pull request #491 from navidys/readme_update
Browse files Browse the repository at this point in the history
readme update
  • Loading branch information
navidys authored Jun 8, 2024
2 parents b97a7e9 + 5040e03 commit ab1c7d9
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@
[![Go Report](https://goreportcard.com/badge/github.com/containers/podman-tui)](https://goreportcard.com/report/github.com/containers/podman-tui)
[![codecov](https://codecov.io/gh/navidys/podman-tui/branch/main/graph/badge.svg)](https://codecov.io/gh/navidys/podman-tui)

Terminal user interface for Podman v4 and v5.
Terminal user interface for Podman environment.

![Screenshot](./docs/podman-tui.gif)

- [**Overview**](#overview)
- [**Compatibility Matrix**](#compatibility-matrix)
- [**Installation**](#installation)
- [**PreRun Checks**](#prerun-checks)
- [**Key Bindings**](#key-bindings)
Expand All @@ -19,9 +20,16 @@ Terminal user interface for Podman v4 and v5.

## Overview

podman-tui is a terminal user interface for podman v4 (>=4.0.2) and v5.
podman-tui is a terminal user interface for podman environment.
It is using [podman go bindings](https://github.com/containers/podman/tree/main/pkg/bindings) to communicate with local or remote podman machine (through SSH).

## Compatibility matrix

| Terminal User Interface | Podman |
| ----------- | ------ |
| releaes-1.x | v5.x.y |
| release-0.x | v4.x.y |

## Installation

Building from source (Linux, Windows and MacOS) or installing packaged versions are detailed in [install guide](install.md).
Expand Down

0 comments on commit ab1c7d9

Please sign in to comment.