From 142dc59ffa8a89b3ced1a8e47a37c86d83dde0b5 Mon Sep 17 00:00:00 2001 From: somnek Date: Tue, 16 Jan 2024 04:06:35 +0800 Subject: [PATCH] readme --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1b67849..c56b84f 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,17 @@ +# killer-whale 🐳 +

-# killer-whale 🐳 +Killer Whale is a Docker client that runs in your terminal. It provides an intuitive, easy-to-use interface for managing your Docker containers. -Killer Whale is a Docker TUI for terminal dwellers. It provides an intuitive, easy-to-use interface for managing your Docker containers without leaving the comfort of your command line. +## Features +1. stop, start, kill, remove, pause, unpause +2. allows bulk action +3. inspect containers -- more feature coming soon, thought its temping to add more feature, `killer-whale` meant to be as **easy to use** & as **minimalistic** as possible. +Thought its tempting to add more features, `killer-whale` meant to be as **easy to use** & as **minimalistic** as possible. ## Usage @@ -25,7 +30,7 @@ go run . or build it: ```bash -cd killer-whale && go build -o killer-whale +cd killer-whale && go build -o killer ``` Once the build is complete, move the executable to a directory in your system's `PATH` environment variable so that you can run it from anywhere.