Skip to content

Commit f109ac8

Browse files
committed
docs(README): adjust README
1 parent d178f7c commit f109ac8

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# node-command-line-starter
2+
Progammers are lazy. As soon as we have to do the same task over and over again we start on automizing it.
3+
Automization is often done in the form of a command line utility.
4+
5+
This starter provides you with all the necessary setup to quickly create your node-command-line utility. It provides you all the
6+
necessary setup so that you can focus on your util and don't loose time with
7+
the project setup.
8+
9+
The starter also provides you all the setup for quickly pushing new versions to your npm repositiory.
10+
11+
## What's included?
12+
13+
### Testing
14+
- [Jest](https://jestjs.io/) - JavaScript Testing Framework
15+
- Jest configurations to mock third party libaries
16+
- Sample tests
17+
18+
### Command line utils
19+
- [Commander](https://github.com/tj/commander.js) - Complete solution for node.js command-line interfaces.
20+
- [Chalk](https://github.com/chalk/chalk) - Terminal string styling
21+
- [Boxen](https://github.com/sindresorhus/boxen#readme) - Create boxes in terminal
22+
23+
### Dev utilities
24+
- [Prettier](https://prettier.io/) - Code formater
25+
- [Husky](https://github.com/typicode/husky) and [Lint-staged](https://github.com/okonet/lint-staged) to run prettier on each commit on staged files.
26+
27+
### Build tools
28+
- [Codecov](https://codecov.io/) - Integration to upload your coverage report to codecov
29+
- [Travis](https://travis-ci.org/) - Sample travis file with all the necessary build steps
30+
- [SemanticRelease](https://github.com/semantic-release/semantic-release) - All the setup to use semantic release. Publish your command line utility to npm by using conventional commits
31+

0 commit comments

Comments
 (0)