Skip to content

Commit fb46f51

Browse files
committed
Add postinstall script
1 parent 618973a commit fb46f51

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

_postinstall.js

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
const chalk = require('chalk');
2+
3+
process.stdout.write(chalk.white(`
4+
${chalk.yellow('| ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ |')}
5+
${chalk.blue(`🙏 Thanks for downloading ${chalk.green('gren')}`)}
6+
${chalk.yellow('| ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ |')}
7+
8+
Before you start:
9+
10+
1. Generate a token with ${chalk.yellow('repo scope')} at this link: ${chalk.blue('https://github.com/settings/tokens/new')}
11+
2. Run ${chalk.green('gren init')} to create a config file
12+
3. Run ${chalk.green('gren help')} for more help or see ${chalk.blue('https://github-tools.github.io/github-release-notes/')}
13+
14+
For any questions/issues, go here: ${chalk.blue('https://github.com/github-tools/github-release-notes/issues')}
15+
16+
If you like ${chalk.green('gren')}, feel free to ⭐ it!
17+
18+
19+
${chalk.yellow('.:| ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ |:.')}
20+
21+
22+
`));

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
"coverage": "nyc --reporter=lcov --reporter=text mocha --compilers=js:babel-register",
1010
"options": "node tasks/_generate-options.js",
1111
"examples": "node tasks/_generate-examples.js",
12-
"docs": "npm run options && npm run examples && node_modules/.bin/jsdoc -c .jsdoc.conf.json --verbose"
12+
"docs": "npm run options && npm run examples && node_modules/.bin/jsdoc -c .jsdoc.conf.json --verbose",
13+
"postinstall": "node ./_postinstall.js"
1314
},
1415
"repository": {
1516
"type": "git",

0 commit comments

Comments
 (0)