fancier readme with screenshot

swartzrock · Dec 14, 2020 · 3ccbeb1 · 3ccbeb1
1 parent a798a78
commit 3ccbeb1
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,17 @@
-# ecsview
+
+![screenshot](docs/logo.jpg)
+
+EcsView (ecsview) is a terminal UI for browsing Amazon Elastic Container Service (ECS) clusters. You can use it to view cluster usage, services, tasks, and individual container instances (ec2's). Uses the excellent [tview](https://github.com/rivo/tview/) library to build and manage the UI.
+
+
+![screenshot](docs/tasksview.jpg)
+
+## Installation
+
+Run `make install` to install ecsview in your Go binaries directory.
+
+## Usage
+
+Run `AWS_PROFILE=<profile> ecsview` with a configured AWS profile to view your account's ECS clusters in detail.
+
+
diff --git a/docs/logo.jpg b/docs/logo.jpg
diff --git a/docs/tasksview.jpg b/docs/tasksview.jpg