summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorElliot Blackburn <elliot@lybrary.io>2017-11-23 13:55:59 +0000
committerGitHub <noreply@github.com>2017-11-23 13:55:59 +0000
commit7ceaa401c976f39474e843dc8a5f6e7c5373f97e (patch)
tree7205bfc354100c7f1e33646f8728fb0e07131853
parent149c7fda3289366fea0b85d95b2f710df44c13ce (diff)
Add more detail to usage description
The usage description was good, but it didn't state how to start the application. To most veteran node users this would be self explanatory, but to others this may be difficult to work out.
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index dd86992..4dbeff5 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,14 @@ $ npm install gtop -g
### Usage
+Start gtop with the `gtop` command
+
+```sh
+$ gtop
+```
+
+To stop gtop, use `ctrl+c` in most shell environments.
+
You can sort the process table by pressing
* `p`: Process Id