Permalink
Browse files

Update and rename README.md to README.rst

  • Loading branch information...
1 parent d103c57 commit d665fca965e1b50b79c93a66d1db51626c02c9c2 @steveschnepp steveschnepp committed Dec 8, 2014
Showing with 28 additions and 14 deletions.
  1. +0 −14 README.md
  2. +28 −0 README.rst
View
@@ -1,14 +0,0 @@
-munin-c
-=======
-
-C rewrite of various munin components
-
-compiling
-=========
-This project has been ported to autotools. You have to use:
-
- autoreconf -i -I m4 && ./configure && make
-
-license
-=======
-munin-c is licensed as gpl-2 or gpl-3 at your choice.
View
@@ -0,0 +1,28 @@
+munin-c
+=======
+
+C rewrite of munin node components. It currently consists on a light-weight
+node, and some plugins. These are designed to be very light on resources,
+and compatible with the stock ones.
+
+Compatibility
+-------------
+
+A main design feature is that munin-c components are drop-ins to stock ones.
+Therefore the munin-c node can run the stock plugins, and the plugins can be
+run by the stock node. There are still some missing parts in the node, mostly
+about the permission, and the environnements.
+
+The config file has also the same syntax.
+
+3rd-party plugins should also work unmodified.
+
+Compiling
+=========
+This project has been ported to autotools. You have to use::
+
+ autoreconf -i -I m4 && ./configure && make
+
+License
+=======
+munin-c is licensed as gpl-2 or gpl-3 at your choice.

0 comments on commit d665fca

Please sign in to comment.