init

1 files changed, 27 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1b527a5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# watchdog
+
+Monitor CPU usage by process and report bursts to a logfile.
+
+## Invocation
+
+```sh
+watchdog [logfile]
+```
+
+Default logfile is `watchdog.log` in the current directory.
+
+## Build
+
+Compile using `make` or `cc watchdog.c -O3 -o watchdog`.
+
+See [watchdog.c](watchdog.c) for configuration options.
+
+Install to PREFIX using `make install`.
+
+## Test watchdog
+
+```sh
+$ watchdog &
+$ tail -f watchdog.log
+$ cat < /dev/random > /dev/null # in a different shell
+```