add README

[trinked.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..5827b31
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+Trinketd - driver and collecting tool for Atom Pro/Atom mini 2.
+
+The tool was developed for FreeBSD but it should be very easy to port it on
+Linux.
+
+trinketd [-d] [-p pidfile] [-P period] [-D datadir] [-i tics] [-l logfile]
+
+-i d        - daemonize
+-p pidfile  - create a pid-file
+-P period   - collection period, in seconds, default 300 secs
+-D datadir  - directory to place output file, default stdout
+-i tics     - the number of samples for the moving average, default 1
+-l logfile  - name of log file, if absent will send to syslog if daemonize else
+              stderr
+
+Copyright (c) 2016, Teodor Sigaev <teodor@sigaev.ru>