Docs: updated readme

sfluor · Apr 15, 2018 · d6385c2 · d6385c2
1 parent d5b05cc
commit d6385c2
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,20 @@
 # gops
+
+Gops is a tool to monitor a specific process ressources, it's inspired by [psrecord](github.com/astrofrog/psrecord)
+
+![Example](./record.png "Example")
+
+## Installation
+
+1. You can download the latest release [here](https://github.com/sfluor/gops/releases)
+2. Or you can install it by building it manually with:
+```bash
+go get github.com/sfluor/gops
+cd $GOPATH/github.com/sfluor/gops
+dep ensure
+go build
+``` 
+
+## Usage
+
+You can monitor firefox usage by doing `gops $(pgrep firefox)` and stop it with `^C` to register firefox resources usage in record.png.
diff --git a/record.png b/record.png