Merge branch 'dev'

Author: nmicht

README.md

@@ -10,57 +10,45 @@ An [npm initializer][npm/init] to scaffold a node project and include basic tool
 
 ## Requirements
 
-- `npm >= x.x`
-- `node >= x.x`
+- `npm >= 6.5`
+- `node >= 10.9`
 
 ## Usage
 
-`npm init node-project path/to/project [params]`
+`npm init node-project path/to/project`
 
-## Params
+## What it does
 
-### Project path
-
-`npm init node-project path/to/project [params]`
-
-Will create a new folder for the project in the specified path.
+1. Create the folder for the new project
+1. Guide you through a questionnarie to setup the project
+2. Initialize a git repo
+3. Copy the template files (src, eslintrc, gitignore, readme, etc)
+4. Can create a Github repository
+5. Install eslint
+5. Install the selected testing dependencies
+6. Generate package.json with all the project details
+7. Commit and push the initial commit
 
 ## About this package
 
 So, this started as a dry thing.  
-I'm not super 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.  
+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.  
 So, the idea is to have a create package to use it in the form of:  
-`npm init node-project a-demo-project`  
+`npm init node-project path/to/project`
 and with this have a new folder my-new-project with everything ready to work.  
 
 I know there are a lot of similar packages out there, but the idea is to learn more about nodejs api, handling files, packages, etc.
 
-So far, what this package will do (already does) is:
-1. Create the folder for the new project
-2. Create a git repo
-3. Copy the structure for files (src, and root files like eslintrc, gitignore, readme, etc)
-4. Create a github repository
-5. Install eslint and jest dependencies
-6. Update package.json
-7. Commit and push the initial commit
+## Future features
 
-What I have in my TODO list:
 1. Fix the structure of modules, classes and etc
-2. ~~Avoid as much dependencies as possible~~
-3. ~~Understand about the difference for eslint airbnb and eslint plugin node~~
 4. Add unit testing
-5. ~~Improve the calls for shell (right now is with exec, but I need to use spawn in order to have the stdout inherit, but that mess with the sync method and the responses)~~
-6. ~~Add documentation for classes, modules and methods~~
 7. Add options to create the project with params instead of questionnaire
-8. ~~Add questionnaire for the creation~~
-9. Publish the npm package
 10. Add a good error handler
 11. Color for the console messages
 12. Modify template structure (the one that is generated in the new project) to include unit test
 13. Include license files to the template copy/update process
 14. A logger ? (just for learning)
-15. ~~CWD for git commands~~
-16. Best place for the auth.json
 17. Ability to handle auth for different github accounts
 18. Option to questionnaire with all the default values
 
@@ -99,7 +87,7 @@ If you are planning to allow this script to create your github repositories, is
 [license-url]: LICENSE
 [license-image]: https://img.shields.io/github/license/ahmadnassri/node-create.svg?style=for-the-badge&logo=circleci
 
-[npm-url]: https://www.npmjs.com/package/@nmicht/create
+[npm-url]: https://www.npmjs.com/package/create-nodejs-project
 [npm-image]: https://img.shields.io/npm/v/@nmicht/create.svg?style=for-the-badge&logo=npm
 
 [npm/init]: https://docs.npmjs.com/cli/init#description

package-lock.json

@@ -1,6 +1,6 @@
 {
-  "name": "create-node-project",
-  "version": "0.1.0",
+  "name": "create-nodejs-project",
+  "version": "0.1.2",
   "description": "An npm initializer to scaffold a node project and include basic tools like lint, testing, etc.",
   "main": "src/index.js",
   "bin": "src/index.js",
@@ -39,10 +39,10 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/nmicht/create-node-project.git"
+    "url": "git+https://github.com/nmicht/create-nodejs-project.git"
   },
   "bugs": {
-    "url": "https://github.com/nmicht/create-node-project/issues"
+    "url": "https://github.com/nmicht/create-nodejs-project/issues"
   },
-  "homepage": "https://github.com/nmicht/create-node-project#readme"
+  "homepage": "https://github.com/nmicht/create-nodejs-project#readme"
 }

package.json

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 const path = require('path');
 const fs = require('fs');