Skip to content

Commit 5db6ad8

Browse files
committedMar 30, 2021
[Release] v1.0.20210331
1 parent adeeb40 commit 5db6ad8

File tree

4 files changed

+22
-8
lines changed

4 files changed

+22
-8
lines changed
 

‎.npmignore

+2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
**/*
2+
!/.husky
3+
!/.github
24
!/dist/**/*
35
!/extra/**/*
46
!*.md

‎CHANGELOG.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1-
# v1.0.20210330 (March 30, 2021)
1+
# v1.0.20210331 (March 31, 2021)
22

3-
- First release
3+
- Minor updates
44

55
<!-- all-shields/sponsors-badges:START -->
66
[![Donate Paypal](https://img.shields.io/badge/donate-paypal-005EA6.svg?style=flat&logo=paypal)](https://www.paypal.me/ptkdev) [![Donate Ko-Fi](https://img.shields.io/badge/donate-ko--fi-29abe0.svg?style=flat&logo=ko-fi)](https://ko-fi.com/ptkdev) [![Donate Github Sponsors](https://img.shields.io/badge/donate-sponsors-ea4aaa.svg?style=flat&logo=github)](https://github.com/sponsors/ptkdev) [![Donate Patreon](https://img.shields.io/badge/donate-patreon-F87668.svg?style=flat&logo=patreon)](https://www.patreon.com/ptkdev) [![Donate Bitcoin](https://img.shields.io/badge/donate-35jQmZCy4nsxoMM3QPFrnZePDVhdKaHMRH-E38B29.svg?style=flat&logo=bitcoin)]() [![Donate Ethereum](https://img.shields.io/badge/donate-0x8b8171661bEb032828e82baBb0B5B98Ba8fBEBFc-4E8EE9.svg?style=flat&logo=ethereum)]()
77
<!-- all-shields/sponsors-badges:END -->
8+
9+
# v1.0.20210330 (March 30, 2021)
10+
11+
- First release

‎README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# 🪓 node-cli-boilerplate
22

33
<!-- all-shields/header-badges:START -->
4-
[![v1.0.20210330](https://img.shields.io/badge/version-v1.0.20210330-lightgray.svg?style=flat&logo=)](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/blob/main/CHANGELOG.md) [![](https://img.shields.io/npm/v/@ptkdev/node-cli-boilerplate?color=CC3534&logo=npm)](https://www.npmjs.com/package/@ptkdev/node-cli-boilerplate) [![License: MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat&logo=license)](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/blob/main/LICENSE.md) [![Language: TypeScript](https://img.shields.io/badge/language-typescript-blue.svg?style=flat&logo=typescript)](https://www.typescriptlang.org/) [![ECMAScript: 2019](https://img.shields.io/badge/ES-9-F7DF1E.svg?style=flat&logo=javascript)](https://github.com/tc39/ecma262) [![Discord Server](https://discordapp.com/api/guilds/383373985666301975/embed.png)](https://discord.ptkdev.io)
4+
[![v1.0.20210331](https://img.shields.io/badge/version-v1.0.20210331-lightgray.svg?style=flat&logo=)](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/blob/main/CHANGELOG.md) [![](https://img.shields.io/npm/v/@ptkdev/node-cli-boilerplate?color=CC3534&logo=npm)](https://www.npmjs.com/package/@ptkdev/node-cli-boilerplate) [![License: MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat&logo=license)](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/blob/main/LICENSE.md) [![Language: TypeScript](https://img.shields.io/badge/language-typescript-blue.svg?style=flat&logo=typescript)](https://www.typescriptlang.org/) [![ECMAScript: 2019](https://img.shields.io/badge/ES-9-F7DF1E.svg?style=flat&logo=javascript)](https://github.com/tc39/ecma262) [![Discord Server](https://discordapp.com/api/guilds/383373985666301975/embed.png)](https://discord.ptkdev.io)
55
<!-- all-shields/header-badges:END -->
66

77
Create node cli with this friendly boilerplate. Use this respository as template for your new node command line interface project
@@ -17,6 +17,7 @@ Create node cli with this friendly boilerplate. Use this respository as template
1717
## 📎 Menu
1818

1919
- 💡 [Features](#-features)
20+
- 🚀 [How to use](#-usage)
2021
- 🔨 [Developer Mode](#-developer-mode)
2122
- 👨‍💻 [Contributing](#-contributing)
2223
- 🐛 [Known Bugs](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
@@ -38,6 +39,13 @@ Create node cli with this friendly boilerplate. Use this respository as template
3839
- [✔️] i18n translations
3940
- [✔️] Github and Vscode dotfiles preconfigured
4041

42+
## 🚀 Usage
43+
44+
1. In your node project run: `npm install @ptkdev/node-cli-boilerplate -g`
45+
2. Usage, run anywhere: `node-cli-boilerplate`
46+
47+
You can use npx, example: `npx @ptkdev/node-cli-boilerplate`
48+
4149
## 🔨 Developer Mode
4250

4351
1. Clone this repository or download [nightly](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/archive/nightly.zip), [beta](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/archive/beta.zip) or [stable](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/archive/main.zip).

‎package.json

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22
"name": "@ptkdev/node-cli-boilerplate",
33
"displayName": "Node Command Line Interface Boilerplate",
44
"description": "Create node cli with this friendly boilerplate. Use this respository as template for your new node command line interface project",
5-
"version": "1.0.20210330",
5+
"version": "1.0.20210331",
66
"main": "dist/cli/cli.js",
77
"types": "dist/types/module.type.d.js",
88
"bin": {
9-
"node-cli-boilerplate": "dist/cli/cli.js"
9+
"node-cli-boilerplate": "dist/cli/cli.js",
10+
"@ptkdev/node-cli-boilerplate": "dist/cli/cli.js"
1011
},
1112
"publishConfig": {
1213
"access": "public"
@@ -48,10 +49,9 @@
4849
"contributors-generate": "all-contributors generate",
4950
"all-shields-generate": "all-shields-generate",
5051
"pre-commit": "npm run contributors-generate && npm run all-shields-generate && npm run lint-fix && npm run test",
51-
"pkg-clean": "rm -rf node_modules package-lock.json && npm install",
52+
"pkg-clean": "rm -rf node_modules package-lock.json && npm install && husky install",
5253
"pkg-update": "npm update",
53-
"pkg-upgrade": "npx npm-check-updates -u && npm install",
54-
"postinstall": "husky install"
54+
"pkg-upgrade": "npx npm-check-updates -u && npm install && husky install"
5555
},
5656
"devDependencies": {
5757
"@ptkdev/all-shields-cli": "^1.3.0",

0 commit comments

Comments
 (0)
Please sign in to comment.