Skip to content

Commit

Permalink
Updated docs and license
Browse files Browse the repository at this point in the history
  • Loading branch information
enenkel committed Feb 10, 2017
1 parent dfe4e86 commit 3b2bea8
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 30 deletions.
41 changes: 19 additions & 22 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,24 +1,21 @@
Copyright (c) 2017, Andreas Enenkel <ae@omm-solutions.de>
All rights reserved.
The MIT License (MIT)

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of the <organization> nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.
Copyright (c) 2016-2017 OMM Solutions GmbH (http://omm-solutions.de/)

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Generator-NExT [![NPM version][npm-image]][npm-url]
> Generator that provides a basic setup for a Node project with Express and Typescript.
> Generator that provides a basic setup for a **N**ode project with **Ex**press and **T**ypescript.
## Installation

Expand All @@ -13,7 +13,7 @@ npm install -g generator-next
Then generate your new project:

```bash
yo next
yo next <root directory>
```

Feel free to [learn more about Yeoman](http://yeoman.io/).
Expand Down Expand Up @@ -50,9 +50,15 @@ Feel free to [learn more about Yeoman](http://yeoman.io/).
- [Typedoc](https://github.com/TypeStrong/typedoc)


## Roadmap

Version 0.3.x: Implement sub generator which adds [pug](https://github.com/pugjs/pug)
Version 0.4.x: Implement sub generator which adds [mongoose](https://github.com/Automattic/mongoose)
Version 1.x.x: Combine all sub generators on demand.

## License

BSD-3-Clause © [Andreas Enenkel]()
MIT

[npm-image]: https://badge.fury.io/js/generator-next.svg
[npm-url]: https://npmjs.org/package/generator-next
Expand Down
11 changes: 7 additions & 4 deletions generators/app/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ class NExTGenerator extends Generator {

prompting() {

var prompts = [
let prompts = [
{
type: "input",
name: ROOT_DIRECTORY,
message: "Specify project root directory.",
message: "Enter root directory.",
default: this.options.appname
},
{
Expand Down Expand Up @@ -127,9 +127,12 @@ class NExTGenerator extends Generator {
}

end() {
this.log("Scaffold generated");
this.log("NExT scaffolding was generated");
this.log("Below you'll find some things that are up to you:");
this.log(" - insert detailed information in package.json, e.g. description of project");
this.log(" - Insert detailed information in package.json, e.g. description of project.");
this.log(" - Replace the demo test functions with actual ones.");
this.log("\nThanks for using the NExt Generator!");
this.log("Feel free to star, fork and create issues on GitHub https://github.com/ommsolutions/generator-next ...");
}
}
module.exports = NExTGenerator;
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "generator-next",
"version": "0.1.1",
"version": "0.2.0",
"description": "Generator that provides a basic setup for a Node project with Express and Typescript.",
"homepage": "https://github.com/ommsolutions/generator-next",
"author": {
Expand Down

0 comments on commit 3b2bea8

Please sign in to comment.