Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve README #20

Merged
merged 1 commit into from
Jun 30, 2024
Merged

docs: improve README #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 28 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,30 @@
# Ducker
<p align="center">
<h1 align="center">Ducker</h1>
</p>

A terminal app for managing docker containers, inpired by [K9s](https://k9scli.io/)
<p align="center">
🐋 A terminal app for managing docker containers, inpired by <a href="https://l9scli.io">K9s</a>
<br/>
<a href="#installation">Installation</a> · <a href="#useage">Useage</a> · <a href="#configuration">Configuration</a>
</p>

❗❗❗ **Note:** Ducker is currently in a "pre-release" state. ❗❗❗

By all means install and try it out, but it is currently undergoing active development, and there are a number of known issues and features in the pipeline (see the pinned issue).
<a href="https://github.com/robertpsoane/ducker"><img srf="https://raw.githubusercontent.com/robertpsoane/ducker/master/demo.gif?raw=true" width="100%" /></a>

<p align="center">
🦀 Written in Rust 🦀
</p>

![](https://raw.githubusercontent.com/robertpsoane/ducker/master/demo.gif?raw=true)
## Installation

<p align="center">
❗ Note: Ducker is currently in a "pre-release" state. ❗
<br/>
Please do install and try it out - it is currently undergoing active development. There are a number of known issues and features in the pipeline (<a href="https://github.com/robertpsoane/ducker/issues/2">see the pinned issue</a>). Any feedback is welcome.
</p>

## Installation

### Cargo

There isn't currently a downloadable build; to install you will need cargo installed:

Expand All @@ -26,6 +40,14 @@ You can install `ducker` from the [AUR](https://aur.archlinux.org/packages/ducke
paru -S ducker
```

### Unstable

To install the latest unstable version of Ducker, run the following command:

```
cargo install --git https://github.com/robertpsoane/ducker
```

## Useage

Ducker is comprised of a set of **pages**, each of which display specific information about and/or allow interaction with the docker containers and images on the host system.
Expand Down
Loading