aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndy Carlson <thecarlsondaddy@gmail.com>2018-01-05 16:01:53 -0500
committerGitHub <noreply@github.com>2018-01-05 16:01:53 -0500
commit5cb0679dd53e62019817c3801f74670a616503d6 (patch)
tree3e7d30b1b7e11f62b5c96fd0275aff516c95f399 /README.md
parent20e22415ed83e9d09afb311613a125f52eddf843 (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8699120..d5464d5 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,19 @@
# quickstat
xinetd service to retrieve basic system information
+
+### Build Requirements
+* xinetd
+* make
+* m4
+
+### Run requirements
+* xinetd
+* iostat
+
+### Installation
+1. Run ```make setup``` and provide the port number to run service as
+2. Run ```sudo make install```
+
+### Usage
+Query the machine running quickstat (via xinetd) using the following URL:
+```http://HOST:PORT/stats```