Skip to content

Commit

Permalink
modernize the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
James Halliday committed Apr 15, 2013
1 parent 5afd47b commit 24106f5
Showing 1 changed file with 9 additions and 18 deletions.
27 changes: 9 additions & 18 deletions README.markdown → readme.markdown
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
shell-quote
===========
# shell-quote

Parse and quote shell commands.

[![build status](https://secure.travis-ci.org/substack/node-shell-quote.png)](http://travis-ci.org/substack/node-shell-quote)

example
=======
# example

quote
-----
## quote

``` js
var quote = require('shell-quote').quote;
Expand All @@ -23,8 +20,7 @@ output
a 'b c d' \$f '"g"'
```

parse
-----
## parse

``` js`
var parse = require('shell-quote').parse;
Expand All @@ -38,35 +34,30 @@ output
[ 'a', 'b c', '\\$def', 'it\'s great' ]
```
methods
=======
# methods
``` js
var quote = require('shell-quote').quote;
var parse = require('shell-quote').parse;
```

quote(args)
-----------
## quote(args)

Return a quoted string for the array `args` suitable for using in shell
commands.

parse(cmd)
----------
## parse(cmd)

Return an array of arguments from the quoted string `cmd`.

install
=======
# install

With [npm](http://npmjs.org) do:

```
npm install shell-quote
```

license
=======
# license

MIT

0 comments on commit 24106f5

Please sign in to comment.