Skip to content

Commit 73643f8

Browse files
committed
Adding travis and update some things on readme
1 parent efb62b2 commit 73643f8

File tree

4 files changed

+19
-11
lines changed

4 files changed

+19
-11
lines changed

.travis.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
language: node_js
2+
node_js:
3+
- "iojs"
4+
- "10"

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Node.js Project Initializer
44

5-
[![License][license-image]][license-url] [![version][npm-image]][npm-url]
5+
[![License][license-image]][license-url] [![version][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url]
66

77
An [npm initializer][npm/init] to scaffold a node project and include basic tools like lint, testing, etc.
88

@@ -34,11 +34,10 @@ npm init nodejs-project path/to/new/project
3434
## What it does
3535

3636
1. Create the folder for the new project
37-
1. Guide you through a questionnarie to setup the project
37+
1. Guide you through a questionnaire to setup the project
3838
2. Initialize a git repository
3939
3. Copy the template files (src, eslintrc, gitignore, readme, etc)
40-
4. Can create a Github repository
41-
5. Handle the Github tokens for multiple accounts/users
40+
4. Create a Github repository
4241
5. Install eslint dependencies
4342
5. Install the selected testing dependencies
4443
6. Generate package.json with all the project details
@@ -47,22 +46,22 @@ npm init nodejs-project path/to/new/project
4746

4847
## About this package
4948

50-
The motivation started as a **DRY** thing.
49+
Every time that I start a new project in Node.js, I hate to go to other project folder, copy files like eslintrc, editorconfig; install the same dependencies, create folder structure, etc.
5150

52-
I'm not expert with NodeJS, but every time that I start a new project, I hate to go to other project, copy files like eslintrc, editorconfig, install the same dependencies, create folder structure, etc.
51+
With this in mind, the motivation to build this package started as a **DRY** (Do not repeat yourself) thing.
5352

54-
So, the idea is to have an automated way to initialize new NodeJS projects and with this have a new folder with everything ready to work in what really matters.
53+
This package is intended to automated the initialization of new Node.js projects and with this have a new folder with everything ready to work, basically an scaffolding tool.
5554

5655

5756
## Future features
5857

5958
1. Unit testing
60-
7. Options to create the project with params instead of questionnaire
59+
7. Options to create the project with parameters instead of questionnaire
6160
10. A good error handler
6261
11. Color for the console messages
6362
12. Improve the template structure (the one that is generated in the new project) to include unit test
6463
18. Option to questionnaire with all the default values
65-
2. Logic to handle multiple auth files and multiple github accounts
64+
2. Logic to handle multiple authentication files and multiple Github accounts
6665

6766
## Configure Github Authentication
6867

@@ -105,3 +104,6 @@ If you are planning to allow this script to create your Github repositories, is
105104
[npm-image]: https://img.shields.io/npm/v/create-nodejs-project.svg?style=for-the-badge&logo=npm
106105

107106
[npm/init]: https://docs.npmjs.com/cli/init#description
107+
108+
[downloads-url]: https://www.npmjs.com/package/create-nodejs-project
109+
[downloads-image]: https://img.shields.io/npm/dt/create-nodejs-project.svg?style=for-the-badge

templates/nodejs-project/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,6 @@
2727

2828
---
2929

30-
Made with :heart: by [PROJECT_AUTHOR_NAME](PROJECT_AUTHOR_URL) using [node-project initializer](https://github.com/nmicht/create-node-project)
30+
Made with :heart: by [PROJECT_AUTHOR_NAME](PROJECT_AUTHOR_URL).
31+
32+
This project was bootstrapped with [nodejs-project initializer](https://github.com/nmicht/create-nodejs-project)

templates/nodejs-project/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"license": "PROJECT_LICENSE",
99
"private": PROJECT_PRIVATE,
1010
"engines": {
11-
"node": ">=10.9.0"
11+
"node": ">=10.12.0"
1212
},
1313
"scripts": {
1414
"start": "node ./src/index.js"

0 commit comments

Comments
 (0)