diff --git a/README.md b/README.md index 27d020d..603cc42 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,14 @@ # ctop -Curses-based container metric interface +**NOTE** *This project, while largely usable, is a work in progress! This message will be removed upon initial stable release* + +Top-like interface for container metrics + +## Quickstart + +To build and run ctop: +```bash +git clone https://github.com/bcicen/ctop.git +cd ctop +go build && ./ctop +```