documentation for the public

9 years ago · 2d545423d7
parent 21e82603cb
commit 2d545423d7
1 changed files with 6 additions and 0 deletions
--- a/readme.md
+++ b/readme.md
@ -0,0 +1,6 @@
+#Introduction
+This program is designed to monitor processes running on a linux/osx machine. It assumes logging hasn't been properly done.
+The program answers basic questions:
+
+	- Is a given program still running
+	- How much resource (memory/cpu) a program is eating up