-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0173b43
commit 85f145e
Showing
26 changed files
with
42 additions
and
22 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# <%= name %> | ||
|
||
<a href="https://github.com/vinayakkulkarni/janak"> | ||
<img alt="Built with Janak" src="https://img.shields.io/badge/built%20using-janak-brightgreen"> | ||
</a> | ||
|
||
> <%= description %> | ||
## Features | ||
|
||
- [Ava](https://ava.li) for unit testing | ||
- [Prettier](https://http://prettier.io/) & [ESLint](https://eslint.org) to ensure nice linted code | ||
- [Rollup](https://rollupjs.org/guide/en/) to bundle your awesome <%= name %> | ||
- [Commitlint](http://commitlint.js.org/) & [Husky](https://github.com/typicode/husky) provide you with githooks so your commits follow [commit convention](https://commitlint.js.org/#/concepts-commit-conventions) | ||
- [Dependabot](https://github.blog/2020-06-01-keep-all-your-packages-up-to-date-with-dependabot/) support out of the box | ||
- [Ship.js](https://community.algolia.com/shipjs/) to ensure automated releases & changelog generation | ||
|
||
## Usage | ||
|
||
```bash | ||
# Installs all required dependencies | ||
$ npm install | ||
# Runs the linter - ESLint & Prettier | ||
$ npm run lint | ||
# Prepares a new version for your awesome <%= name %> | ||
$ npm run release:prepare | ||
``` | ||
|
||
## License | ||
|
||
MIT © <%= username %> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.