Files
nexe/README.md
T
Fritz Lin 7308d9665d Update README.md
Better style with Code Usage in README.md
2014-05-28 22:02:28 +08:00

76 lines
1.4 KiB
Markdown

### Nexe
Nexe is a command-line utility that compiles your Node.js application into a single executable file.
![screen shot 2014-02-28 at 10 32 54 am](https://f.cloud.github.com/assets/757408/2296993/c276f7b6-a0a6-11e3-86d3-e6c5feba2a85.png)
### Motivation
- Ability to run multiple applications with *different* node.js runtimes.
- Distributable binaries without needing node / npm.
- Starts faster.
- Lockdown specific application versions, and easily rollback.
- Faster deployments.
## Requirements
- Linux / Mac / BSD / Windows
- Windows: Python 2.6 or 2.7 (in PATH), Visual Studio 2010 or 2012
## Caveats
- Doesn't support native modules (yet).
## Installation
Via NPM:
```bash
npm install nexe [-g]
```
Or git:
```bash
git clone
```
### CLI Usage
````text
Usage: nexe -i [sources] -o [binary]
Options:
-i, --input The entry javascript files [default: cwd]
-o, --output The output binary [default: cwd/release/app.nex]
-r, --runtime The node.js runtime to use [default: "0.8.15"]
-t, --temp The path to store node.js sources [default: /tmp/nexe]
-f, --flags Don't parse node and v8 flags, pass through app flags [default: false]
````
### Code Usage
````javascript
var nexe = require('nexe');
nexe.compile({
input: 'input.js',
output: 'path/to/bin',
runtime: '0.8.15',
flags: true
}, function(err) {
});
````