From d3b4b265a68f576eb616682fc083b4c19a9d3aba Mon Sep 17 00:00:00 2001
From: AJ ONeal <awesome@coolaj86.com>
Date: Sat, 19 Dec 2015 10:15:22 -0800
Subject: [PATCH] Update README.md

---
 README.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 54 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f7cca6b..466412d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,55 @@
 # node-config-python
-Read and write python config files non-destructively (preserves comments)
+
+Read and write python config files non-destructively (preserves comments and lines)
+
+Turns this kind of thing:
+
+```python
+foo = True
+bar = None
+baz = whatever
+qux = apples,bananas
+```
+
+Into this kind of thing:
+
+```javascript
+{ foo: true
+, bar: null
+, baz: "whatever"
+, qux: ["apples", "bananas"]
+}
+```
+
+(comments are stored in meta-data keys `__lines` and `__keys`)
+
+## Install & Usage
+
+```bash
+npm install --save pyconf
+```
+
+```javascript
+var pyconf = require('pyconf');
+
+# alias for fs.readFile() then pyconf.parse()
+pyconf.readFile("/path/to/foo.conf", function (err, obj) {
+  console.log(obj);
+});
+
+pyconf.writeFile("/path/to/foo.conf", obj, function (err, obj) {
+  console.log("wrote file");
+});
+```
+
+Note: the `writeFile` function uses `safe-replace` so that it will work even in environments where race conditions are possible and will also create a backup file `whatever.conf.bak` of the config being overwritten.
+
+## API
+
+```
+pyconf.parse(str, cb)                   => err, object
+pyconf.stringify(obj, cb)               => err, text
+
+pyconf.readFile(filename, cb)           => err, object
+pyconf.writeFile(filename, obj, cb)     => err 
+```