[Pkg-javascript-commits] [node-shell-quote] 32/137: modernize the readme
Bastien Roucariès
rouca at moszumanska.debian.org
Fri Aug 25 19:19:37 UTC 2017
This is an automated email from the git hooks/post-receive script.
rouca pushed a commit to branch master
in repository node-shell-quote.
commit 24106f5c81ab83bddb2bf735cad60e99e1494dcf
Author: James Halliday <mail at substack.net>
Date: Sun Apr 14 21:29:49 2013 -0700
modernize the readme
---
README.markdown => readme.markdown | 27 +++++++++------------------
1 file changed, 9 insertions(+), 18 deletions(-)
diff --git a/README.markdown b/readme.markdown
similarity index 83%
rename from README.markdown
rename to readme.markdown
index 2d18593..1b9a334 100644
--- a/README.markdown
+++ b/readme.markdown
@@ -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;
@@ -23,8 +20,7 @@ output
a 'b c d' \$f '"g"'
```
-parse
------
+## parse
``` js`
var parse = require('shell-quote').parse;
@@ -38,27 +34,23 @@ 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:
@@ -66,7 +58,6 @@ With [npm](http://npmjs.org) do:
npm install shell-quote
```
-license
-=======
+# license
MIT
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-shell-quote.git
More information about the Pkg-javascript-commits
mailing list