[Pkg-javascript-commits] [node-dargs] 03/54: Update readme.md

[Bastien Roucariès]

This is an automated email from the git hooks/post-receive script.

rouca pushed a commit to branch master
in repository node-dargs.

commit 55bf10bea28588be81bc338b6c86280853fed4e6
Author: Sindre Sorhus <sindresorhus at gmail.com>
Date:   Thu Mar 6 17:57:07 2014 +0100

    Update readme.md
---
 readme.md | 25 ++++++++++++++++---------
 1 file changed, 16 insertions(+), 9 deletions(-)

diff --git a/readme.md b/readme.md
index e9df5ed..ab9cc1d 100644
--- a/readme.md
+++ b/readme.md
@@ -1,11 +1,15 @@
-# dargs [![Build Status](https://secure.travis-ci.org/sindresorhus/dargs.png?branch=master)](http://travis-ci.org/sindresorhus/dargs)
+# dargs [![Build Status](https://travis-ci.org/sindresorhus/dargs.png?branch=master)](https://travis-ci.org/sindresorhus/dargs)
 
 > Converts an object of options into an array of command-line arguments
 
+Basically the inverse of an argument parser like nopt or minimist.
 
-## Getting started
 
-Install: `npm install --save dargs`
+## Install
+
+```bash
+$ npm install --save dargs
+```
 
 
 #### Example
@@ -38,20 +42,23 @@ console.log(dargs(options, excludes));
 ```
 
 
-## Documentation
+## API
 
+### dargs(options, excludes)
 
-### options
+#### options
 
-Object of options to convert to command-line arguments.
+Type: `Object`
 
+Options to convert to command-line arguments.
 
-### excludes
+#### excludes
 
-Array of keys to exclude.
+Type: `Array`
 
+Keys to exclude.
 
 
 ## License
 
-MIT License • © [Sindre Sorhus](http://sindresorhus.com)
+[MIT](http://opensource.org/licenses/MIT) © [Sindre Sorhus](http://sindresorhus.com)

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-dargs.git