Skip to content

Commit

Permalink
minor
Browse files Browse the repository at this point in the history
  • Loading branch information
arturadib committed Mar 2, 2012
1 parent ade74a3 commit 7a245b0
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
13 changes: 11 additions & 2 deletions README.md
@@ -1,6 +1,6 @@
# Shell.js - Unix shell commands for Node.js [![Build Status](https://secure.travis-ci.org/arturadib/shell.js.png)](http://travis-ci.org/arturadib/shell.js)

**Why?** Because you want a portable (Windows included) solution to your shell scripts, and you're already familiar with Unix shell commands. No dependencies other than Node.js. No asynchronous callback hell. Just good old shell scripting.
**Why?** Because your JavaScript project needs a portable (Windows included) alternative to Unix shell scripts, and you don't want to learn yet another library(ies). No dependencies other than Node.js. No asynchronous callback hell. Just good old shell scripting.

Shell.js is [unit-tested](http://travis-ci.org/arturadib/shell.js) and battle-tested at Mozilla's [pdf.js](http://github.com/mozilla/pdf.js).

Expand Down Expand Up @@ -33,7 +33,16 @@ if (exec('git commit -am "Auto-commit"').code !== 0) {
}
```

See also `scripts/` for real-life examples.
See `scripts/` for real-world applications.

### Global vs Local

The `shell/global` script is provided as a convenience shortcut. If polluting your global namespace is not desirable, simply require `shell`:

```javascript
var shell = require('shell');
shell.echo('hello world');
```


<!--
Expand Down
2 changes: 1 addition & 1 deletion shell.js
Expand Up @@ -43,7 +43,7 @@ function _cd(options, dir) {
exports.cd = wrap('cd', _cd);

//@
//@ #### shell.pwd()
//@ #### pwd()
//@ Returns the current directory.
function _pwd(options) {
var pwd = path.resolve(process.cwd());
Expand Down

0 comments on commit 7a245b0

Please sign in to comment.