Files
nexe/README.md
T
Craig Condon 66d3454129 updated readme
2011-11-26 17:03:30 -06:00

59 lines
915 B
Markdown

Compile javascript **with** node.js. This allows you to move your executable around *without* needing to install the node.js runtime.
## Requirements
- Linux / Mac (windows soon)
## Installation
Via NPM:
```bash
npm install nexe
```
Or git:
```bash
git clone
```
### Motivation
- Developing client-side utilities without requiring to install a bunch of dependencies first (node.js, npm).
- Ability to run multiple node.js applications with *different* node.js runtimes.
### CLI Usage
````text
Usage: nexe -i [sources] -o [binary]
Options:
-i, --input The entry javascript files [required]
-o, --output The output binary [required]
-r, --runtime The node.js runtime to use [default: "0.6.3"]
````
### Code usage
````javascript
var nexe = require('nexe');
nexe.compile({ entries: 'input.js', output: 'path/to/bin', runtime: '0.6.3' } function() {
});
````