diff --git a/README.md b/README.md index 73033bf..21759bc 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ This is a Node.js engine for running node apps with [Nanobox](http://nanobox.io). ## Usage + To use the Node.js engine, specify `nodejs` as your `engine` in your boxfile.yml ```yaml @@ -11,14 +12,17 @@ run.config: ``` ## Build Process + When [running your app](https://docs.nanboox.io/cli/run/), this engine compiles code by doing the following: - `yarn install` ## Configuration Options + This engine exposes configuration options through the [Boxfile](http://docs.nanobox.io/boxfile/), a yaml config file used to provision and configure your app's infrastructure when using Nanobox. #### Overview of Boxfile Configuration Options + ```yaml run.config: engine: nodejs @@ -31,17 +35,35 @@ run.config: --- #### runtime + Specifies which Node.js runtime and version to use. The following runtimes are available: -- nodejs-0.8 -- nodejs-0.10 -- nodejs-0.12 -- nodejs-4.8 -- nodejs-5.12 -- nodejs-6.11 -- nodejs-7.10 -- nodejs-8.6 -- nodejs-8.9 +- nodejs-0.10.40 +- nodejs-0.12.7 +- nodejs-0.8.28 +- nodejs-10.4.1 +- nodejs-4.2.6 +- nodejs-4.8.4 +- nodejs-5.12.0nb4 +- nodejs-6.11.4 +- nodejs-7.10.1 +- nodejs-8.10.0 +- nodejs-8.11.0 +- nodejs-8.11.1 +- nodejs-8.11.3 +- nodejs-8.6.0 +- nodejs-8.9.0 +- nodejs-8.9.1 +- nodejs-8.9.3 +- nodejs-8.9.4 +- nodejs-9.10.0 +- nodejs-9.11.1 +- nodejs-9.11.2 +- nodejs-9.2.0 +- nodejs-9.3.0 +- nodejs-9.5.0 +- nodejs-9.6.0 +- nodejs-9.8.0 ```yaml run.config: @@ -53,6 +75,7 @@ run.config: --- #### dep_manager + Specifies whether the engine should use npm or yarn to fetch node modules. Defaults to `yarn`. ```yaml @@ -62,6 +85,7 @@ run.config: ``` #### python_version + Specifies the version of Python to install with the following available values: - python-2.7 @@ -75,9 +99,8 @@ run.config: python_version: python-2.7 ``` - - --- ## Help & Support + This is a generic (non-framework-specific) Node.js engine provided by [Nanobox](http://nanobox.io). If you need help with this engine, you can reach out to us in the [#nanobox IRC channel](http://webchat.freenode.net/?channels=nanobox). If you are running into an issue with the engine, feel free to [create a new issue on this project](https://github.com/pagodabox/nanobox-engine-nodejs/issues/new).