add a README and license informationv20170820

1 files changed, 37 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0f01289
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# collectd-systemd
+
+collectd-systemd is a collectd plugin to read some basic stats from
+systemd.  Currently, it reads how many units are in each state
+(inactive/activating/active/reloading/deactivating/failed), how many
+jobs have ever been installed, how many jobs are currently queued, and
+how many jobs have failed.
+
+# Dependencies
+
+ - systemd (obviously)
+ - collectd (obviously), compiled with Python support
+ - python (2 or 3; whichever version collectd was compiled with)
+ - python-dbus
+
+# Installation
+
+The standard GNU process (`./configure --prefix=/usr && make && sudo make install`),
+but instead of running `./configure`, just edit `config.mk` to taste.
+
+To enable it, add `Include "/usr/share/collectd/systemd.conf"` (or
+similar, based on your configured file paths) to your `collectd.conf`.
+
+# License
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.