1 files changed, 22 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..3e6532e
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,22 @@
+# INI-file module #
+
+This module provides resource types for use in managing INI-style configuration
+files.  The main resource type is `ini_setting`, which is used to manage an
+individual setting in an INI file.  Here's an example usage:
+
+    ini_setting { "sample setting":
+      path    => '/tmp/foo.ini',
+      section => 'foo',
+      setting => 'foosetting',
+      value   => 'FOO!',
+      ensure  => present,
+    }
+
+A few noteworthy features:
+
+ * The module tries *hard* not to manipulate your file any more than it needs to.
+   In most cases, it should leave the original whitespace, comments, ordering,
+   etc. perfectly intact.
+ * Supports comments starting with either '#' or ';'.
+ * Will add missing sections if they don't exist.
+