diff --git a/README.md b/README.md index 673abde23..e00a97478 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,8 @@ Nitro is simple, fast and flexible. It works on macOS, Windows and Linux. Use th ## Usage Before using, you need of course [node](https://nodejs.org/) installed. -Nitro and the Nitro generator are tested with the current LTS version of node.js (releases 6). -They also work with node.js release 8. +Nitro and the Nitro generator are tested with the current +["Active LTS" versions of node.js](https://github.com/nodejs/Release#release-schedule) (release 6.x and 8.x). Install `yarn`, `yo` and `generator-nitro` globally: @@ -58,6 +58,7 @@ It's possible to pass in these options through the command line: ### Update a project If you run `yo nitro` from an existing project you may update your project to a newer version. +Updating to a new major version needs some more work. Please check the [release notes](https://github.com/namics/generator-nitro/releases) ## Generators @@ -70,7 +71,7 @@ Note: Generators are to be run from the root directory of your project. ## Generated app -See how tho use the [generated app](generators/app/templates/project/docs/nitro.md) +See how to use the [generated app](generators/app/templates/project/docs/nitro.md) ## Testing diff --git a/generators/app/templates/project/docs/nitro.md b/generators/app/templates/project/docs/nitro.md index 728d876b5..e47f66388 100644 --- a/generators/app/templates/project/docs/nitro.md +++ b/generators/app/templates/project/docs/nitro.md @@ -23,8 +23,9 @@ Nitro is simple, fast and flexible. Use this app for all your frontend work. This application was created by the yeoman generator for nitro. Before using, you need of course [node](https://nodejs.org/) installed. -Nitro is tested with the current LTS version of node.js (release 6) -and also works with node.js release 8. +Nitro is tested with the current +["Active LTS" versions of node.js](https://github.com/nodejs/Release#release-schedule) (release 6.x and 8.x). + And also you need [yarn](https://www.npmjs.com/package/yarn), the [yeoman cli tool](https://www.npmjs.com/package/yo) and the yeoman [generator-nitro](https://www.npmjs.com/package/generator-nitro) installed globally. @@ -364,6 +365,11 @@ If you need a different layout for a page, do so in the corresponding view data http://localhost:8080/index?_layout=home ``` +##### Side Note About Extending Data + +Don't overload the view data. It will be deep extended with other data from patterns, request parameters, .... +It's not recommended to use view data for data variations of patterns. + #### Dynamic view data If you want to use dynamic view data (i.e. using data from a database or data which is available in different views),