Skip to content
This repository has been archived by the owner on Jul 17, 2023. It is now read-only.

Commit

Permalink
docs(generator): improve readme, add more info about what gets generated
Browse files Browse the repository at this point in the history
  • Loading branch information
robertrossmann committed Jul 16, 2018
1 parent f35d84b commit d93db2d
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions packages/generator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,23 @@ Yeoman generator to quickly scaffold your Atlas.js app.

Answer a couple of questions and you are good to go!

## Options & outputs

This generator will create the following for you:

- A Babel compilation toolchain (to work efficiently with Atlas.js it is recommended to use [class fields][class-fields-proposal]). This also includes [ES2015 modules][esmodules-plugin] support.
- A README file explaining everything you need to know to work with the project you generated
- A recommended file & folder structure for working with Atlas.js
- Various configuration files following a pattern most commonly encountered when working on backend services/APIs
- A makefile with all the necessary build targets to work efficiently on the project
- _(optional)_ ESLint configuration, including the [@strv/eslint-config-javascript][strv-ruleset] ruleset
- _(optional)_ Test suite, consisting of Mocha, Chai.js, Sinon.js and NYC, plus some Chai.js plugins
- _(optional)_ VS Code settings & launch configuration files with recommended options

## License

See the [LICENSE](LICENSE) file for information.

[strv-ruleset]: https://github.com/strvcom/eslint-config-javascript
[class-fields-proposal]: https://babeljs.io/docs/en/next/babel-plugin-proposal-class-properties
[esmodules-plugin]: https://babeljs.io/docs/en/next/babel-plugin-transform-modules-commonjs

0 comments on commit d93db2d

Please sign in to comment.