diff --git a/README.md b/README.md index dba5aba..6ce93e9 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,32 @@ -# Node .ini parser +# Node `.ini` parser -Simple .ini parser for node, supports sections +Simple `.ini` parser for node, supports sections -To parse a .ini file async: -
+To parse a `.ini` file async:
+```javascript
var iniparser = require('iniparser');
iniparser.parse('./config.ini', function(err,data){
var version = data.version;
});
-
+```
-To parse a .ini file sync:
-
+To parse a `.ini` file sync:
+```javascript
var iniparser = require('iniparser');
var config = iniparser.parseSync('./config.ini');
-
+```
-To parse a string in .ini format:
-
+To parse a string in `.ini` format:
+```javascript
var iniparser = require('iniparser');
var config = iniparser.parseString('foo=bar');
-
+```
## Installation
-npm:
+Using [npm](https://npmjs.org/):
-`npm install iniparser`
+```bash
+$ npm install iniparser
+```
## License
(The MIT License)