From f97b2d4d8f33691c9f9a12b3c9bed762885d5529 Mon Sep 17 00:00:00 2001 From: Olivier Date: Thu, 11 Jul 2013 20:46:10 +0200 Subject: [PATCH 1/2] improve lisibility --- README.md | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index dba5aba..8d2b1cb 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: +[npm](): -`npm install iniparser` +```bash +npm install iniparser +``` ## License (The MIT License) From b6cbae67a4c019548fbb5e41dc766ce08f9f17b3 Mon Sep 17 00:00:00 2001 From: Olivier Date: Thu, 11 Jul 2013 20:48:03 +0200 Subject: [PATCH 2/2] improve lisibility -- fixes --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8d2b1cb..6ce93e9 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ iniparser.parse('./config.ini', function(err,data){ ``` To parse a `.ini` file sync: -```javascript``` +```javascript var iniparser = require('iniparser'); var config = iniparser.parseSync('./config.ini'); ``` @@ -22,10 +22,10 @@ var iniparser = require('iniparser'); var config = iniparser.parseString('foo=bar'); ``` ## Installation -[npm](): +Using [npm](https://npmjs.org/): ```bash -npm install iniparser +$ npm install iniparser ``` ## License