Skip to content

Commit 032e589

Browse files
committed
🔜 Update the progress and changelog
1 parent 36267c6 commit 032e589

File tree

3 files changed

+14
-14
lines changed

3 files changed

+14
-14
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
* Handle the Github tokens for multiple accounts/users
66
* Fix problem with keywords on package.json
7+
* Post install script to setup github auth details
78

89
## 0.1.3
910

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<img width="75px" height="75px" align="right" alt="Create NodeJS Project Logo" src="" title="Create NodeJS Project"/>
1+
<img width="75px" height="75px" align="right" alt="Create NodeJS Project Logo" src="https://raw.githubusercontent.com/nmicht/create-nodejs-project/master/assets/create-nodejs-project.png" title="Create NodeJS Project"/>
22

33
# Node Project Initializer
44

@@ -19,22 +19,23 @@ An [npm initializer][npm/init] to scaffold a node project and include basic tool
1919

2020
1. Install the package as global
2121
```
22-
npm install -g create-nodejs-project
22+
npm install -g create-NodeJS-project
2323
```
2424

25-
2. Config your github information
26-
See [Github Auth](#configure-github-authentication)
25+
2. You will be prompted for your Github information
26+
If you do not have the information at the moment, you can keep it empty.
27+
In order to create projects with Github integration, you will need to add the authentication information later. See [Github Auth](#configure-Github-authentication)
2728

2829
3. Create your project
2930
```
30-
npm init nodejs-project path/to/new/project
31+
npm init NodeJS-project path/to/new/project
3132
```
3233

3334
## What it does
3435

3536
1. Create the folder for the new project
3637
1. Guide you through a questionnarie to setup the project
37-
2. Initialize a git repo
38+
2. Initialize a git repository
3839
3. Copy the template files (src, eslintrc, gitignore, readme, etc)
3940
4. Can create a Github repository
4041
5. Handle the Github tokens for multiple accounts/users
@@ -55,23 +56,21 @@ So, the idea is to have a create package to use it in the form of:
5556

5657
and with this have a new folder my-new-project with everything ready to work.
5758

58-
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.
59+
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.
5960

6061
## Future features
6162

62-
1. Fix the structure of modules, classes and etc
63-
4. Unit testing
63+
1. Unit testing
6464
7. Options to create the project with params instead of questionnaire
6565
10. A good error handler
6666
11. Color for the console messages
6767
12. Improve the template structure (the one that is generated in the new project) to include unit test
6868
13. Include license files to the template copy/update process
69-
14. A logger ? (just for learning)
7069
18. Option to questionnaire with all the default values
7170

7271
## Configure Github Authentication
7372

74-
If you are planning to allow this script to create your github repositories, is required to generate a Github Token.
73+
If you are planning to allow this script to create your Github repositories, is required to generate a Github Token.
7574

7675
1. Visit https://github.com/settings/tokens.
7776
2. Click Generate new token.
@@ -87,13 +86,13 @@ If you are planning to allow this script to create your github repositories, is
8786
```
8887
3. Click Generate token.
8988
4. Copy the generated string to a safe place, such as a password safe.
90-
5. Open Terminal and add the github token. Note: The file may be empty, you can use `auth-example.json` to copy and paste.
89+
5. Open Terminal and add the Github token.
9190

9291
```
9392
# nano ~/auth.json
9493
9594
{
96-
"github": [
95+
"Github": [
9796
{
9897
"user": "YOUR_USER",
9998
"token": "YOUR_TOKEN"
@@ -109,7 +108,7 @@ If you are planning to allow this script to create your github repositories, is
109108

110109

111110
[license-url]: LICENSE
112-
[license-image]: https://img.shields.io/github/license/nmicht/create-nodejs-project.svg?style=for-the-badge&logo=appveyor
111+
[license-image]: https://img.shields.io/Github/license/nmicht/create-nodejs-project.svg?style=for-the-badge&logo=appveyor
113112

114113
[npm-url]: https://www.npmjs.com/package/create-nodejs-project
115114
[npm-image]: https://img.shields.io/npm/v/create-nodejs-project.svg?style=for-the-badge&logo=npm

assets/create-nodejs-project.png

8.66 KB
Loading

0 commit comments

Comments
 (0)