diff --git a/README.md b/README.md index a5526ba..e82685b 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ -# ecsview \ No newline at end of file + +![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= 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 new file mode 100644 index 0000000..d21bbb7 Binary files /dev/null and b/docs/logo.jpg differ diff --git a/docs/tasksview.jpg b/docs/tasksview.jpg new file mode 100644 index 0000000..294a894 Binary files /dev/null and b/docs/tasksview.jpg differ