Improve README; check-procs
# check-procs
-## Description
+## Description
Checks processes if the specific metric is outside the required threshold ranges.
-## Setting
+## Synopsis
+```
+check-procs --pattern=PROCESS_NAME --state=STATE --warning-under=N
+```
+
+## Installation
+
+First, build this program.
```
-[plugin.checks.procs]
-command = "/path/to/check-procs --pattern=PROCESS_NAME --state=STATE --warning-under=N"
+go get github.com/mackerelio/go-check-plugins
+cd $(go env GOPATH)/src/github.com/mackerelio/go-check-plugins/check-procs
+go install
```
-## Options
+
+Or you can use this program by installing the official Mackerel package. See [Using the official check plugin pack for check monitoring - Mackerel Docs](https://mackerel.io/docs/entry/howto/mackerel-check-plugins).
+
+
+Next, you can execute this program :-)
+
+```
+check-procs --pattern=PROCESS_NAME --state=STATE --warning-under=N
+```
+
+
+## Setting for mackerel-agent
+
+If there are no problems in the execution result, add s setting in mackerel-agent.conf .
+
+```
+[plugin.checks.check-procs-sample]
+command = ["check-procs", "--pattern", "<PROCESS_NAME>", "--state", "<STATE>", "--warning-under", "N"]
+```
+
+## Usage
+### Options
```
-w, --warning-over=N Trigger a warning if over a number
+ --warn-over=N (DEPRECATED) Trigger a warning if over a number
-c, --critical-over=N Trigger a critical if over a number
-W, --warning-under=N Trigger a warning if under a number (default: 1)
+ --warn-under=N (DEPRECATED) Trigger a warning if under a number (default: 1)
-C, --critical-under=N Trigger a critial if under a number (default: 1)
-m, --match-self Match itself
-M, --match-parent Match parent
@@ -35,7 +66,13 @@ command = "/path/to/check-procs --pattern=PROCESS_NAME --state=STATE --warning-u
-I, --cpu-under=SECONDS Match processes cpu time that is younger than this, in SECONDS
```
+## For more information
+Please refer to the following.
+
+- Read Mackerel Docs; [Monitoring Processes - Mackerel Docs](https://mackerel.io/docs/entry/howto/check/process)
+- Execute `check-procs -h` and you can get command line options.
+
## Other
-* This is a Go port of [Sensu-Plugins-process-checks](https://github.com/sensu-plugins/sensu-plugins-process-checks).
-* [Nagios Plugins - check_procs.c](https://github.com/nagios-plugins/nagios-plugins/blob/master/plugins/check_procs.c)
+- This is a Go port of [Sensu-Plugins-process-checks](https://github.com/sensu-plugins/sensu-plugins-process-checks).
+- [Nagios Plugins - check_procs.c](https://github.com/nagios-plugins/nagios-plugins/blob/master/plugins/check_procs.c)
