add note, quickstart to readme

2017-01-27 01:00:05 +00:00 · 2017-01-27 01:00:05 +00:00 · b8828437ce
parent 1705acf506
commit b8828437ce
1 changed files with 12 additions and 1 deletions
--- 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
+```