Skip to content

Commit 4ac85a8

Browse files
author
Charlike Mike Reagent
committed
fix: generate a readme
Signed-off-by: Charlike Mike Reagent <[email protected]>
1 parent 3de8888 commit 4ac85a8

File tree

2 files changed

+193
-2
lines changed

2 files changed

+193
-2
lines changed

README.md

+183
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
# gitcommit [![npm version][npmv-img]][npmv-url] [![github release][github-release-img]][github-release-url] [![License][license-img]][license-url]
2+
3+
> Lightweight and joyful `git commit` replacement. Conventional Commits compliant.
4+
5+
<div id="thetop"></div>
6+
7+
_You might also be interested in [prompts][highlighted-link] or in the other [related projects](#related-projects)._
8+
9+
## Quality Assurance :100:
10+
11+
[![bitHound Code][bithound-code-img]][bithound-code-url]
12+
[![Code Style Standard][standard-img]][standard-url]
13+
[![Linux Build][circleci-img]][circleci-url]
14+
[![Code Coverage][codecov-img]][codecov-url]
15+
[![bitHound Score][bithound-score-img]][bithound-score-url]
16+
[![bitHound Deps][bithound-deps-img]][bithound-deps-url]
17+
[![Dependencies Status][dependencies-img]][dependencies-url]
18+
19+
If you have any _how-to_ kind of questions, please read [Code of Conduct](./CODE_OF_CONDUCT.md) and **ping me on [twitter](https://twitter.com/tunnckoCore)** or [open an issue][open-issue-url].
20+
You may also read the [Contributing Guide](./CONTRIBUTING.md). There, beside _"How to contribute?"_, we describe everything **_stated_** by the badges.
21+
22+
[![Make A Pull Request][prs-welcome-img]][prs-welcome-url]
23+
[![Code Format Prettier][prettier-img]][prettier-url]
24+
[![Node Security Status][nodesecurity-img]][nodesecurity-url]
25+
[![Conventional Commits][ccommits-img]][ccommits-url]
26+
[![Semantically Released][new-release-img]][new-release-url]
27+
[![Renovate App Status][renovate-img]][renovate-url]
28+
29+
Project is [semantically](https://semver.org) & automatically released on [CircleCI][codecov-url] with [new-release][] and its [New Release](https://github.com/apps/new-release) Github Bot.
30+
31+
[![All Contributors Spec][all-contributors-img]](#contributors)
32+
[![Newsletter Subscribe][tinyletter-img]][tinyletter-url]
33+
[![Give thanks][give-donate-img]][give-donate-url]
34+
[![Share Love Tweet][share-love-img]][share-love-url]
35+
[![NPM Downloads Weekly][downloads-weekly-img]][npmv-url]
36+
[![NPM Downloads Monthly][downloads-monthly-img]][npmv-url]
37+
[![NPM Downloads Total][downloads-total-img]][npmv-url]
38+
39+
## Table of Contents
40+
- [Install](#install)
41+
- [API](#api)
42+
- [Related Projects](#related-projects)
43+
- [Contributing](#contributing)
44+
- [Contributors](#contributors)
45+
- [Users](#users)
46+
- [License](#license)
47+
48+
## Install
49+
50+
This project requires [**Node.js**][nodeversion-url] **v8.6** or above. Install it using [**yarn**](https://yarnpkg.com) **v1.3+** or [**npm**](https://www.npmjs.com) **v5.2+** package managers.
51+
52+
```
53+
$ yarn add gitcommit --dev
54+
```
55+
<!--
56+
A browser usage is also possible, thanks to the [unpkg.com](https://unpkg.com) CDN and [Rollup](https://ghub.now.sh/rollup) bundler.
57+
See available bundles at [`https://unpkg.com/gitcommit/dist/browser/`](https://unpkg.com/gitcommit/dist/browser/).
58+
59+
> _**Note:** May not work in the browser if some of the [Node.js builtin modules](https://github.com/juliangruber/builtins/blob/master/builtins.json) are used here._
60+
-->
61+
62+
## API
63+
Review carefully the provided examples and the working [tests](./test).
64+
65+
**[back to top](#thetop)**
66+
67+
## Related Projects
68+
Some of these projects are used here or were inspiration for this one, others are just related. So, thanks for your existance!
69+
- [hela-config-tunnckocore](https://www.npmjs.com/package/hela-config-tunnckocore): Shareable Config (preset of tasks) for [hela][] task runner | [homepage](https://github.com/tunnckoCore/hela-config-tunnckocore "Shareable Config (preset of tasks) for [hela][] task runner")
70+
- [new-release](https://www.npmjs.com/package/new-release): A stable alternative to [semantic-release][]. Only handles NPM publishing and nothing more… [more](https://github.com/tunnckoCore/new-release#readme) | [homepage](https://github.com/tunnckoCore/new-release#readme "A stable alternative to [semantic-release][]. Only handles NPM publishing and nothing more. For creating GitHub releases use the Semantic Release GitHub App")
71+
- [try-catch-core](https://www.npmjs.com/package/try-catch-core): Low-level package to handle completion and errors of sync or asynchronous functions… [more](https://github.com/hybridables/try-catch-core#readme) | [homepage](https://github.com/hybridables/try-catch-core#readme "Low-level package to handle completion and errors of sync or asynchronous functions, using [once][] and [dezalgo][] libs. Useful for and used in higher-level libs such as [always-done][] to handle completion of anything.")
72+
73+
**[back to top](#thetop)**
74+
75+
## Contributing
76+
Please read the [Contributing Guide](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) documents for advices.
77+
For bugs reports and feature requests, [please create an issue][open-issue-url].
78+
79+
## Contributors
80+
Thanks to the hard work of [these wonderful people](./CONTRIBUTORS.md) this project is alive and it also follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.
81+
[Pull requests](https://github.com/tunnckoCore/contributing#opening-a-pull-request), stars and all kind of [contributions](https://opensource.guide/how-to-contribute/#what-it-means-to-contribute) are always welcome.
82+
83+
## Users
84+
You can see who uses `gitcommit` in the [USERS.md](./USERS.md) file. Please feel free adding this file if it not exists.
85+
If you or your organization are using this project, consider adding yourself to the list of users. **Thank You!**
86+
87+
## License
88+
Copyright (c) 2018-present, [Charlike Mike Reagent][author-link] `<[email protected]>`.
89+
Released under the [Apache-2.0 License][license-url].
90+
91+
***
92+
93+
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on March 07, 2018._
94+
_Project automation and management with [hela][] task framework._
95+
96+
[always-done]: https://github.com/hybridables/always-done
97+
[dezalgo]: https://github.com/npm/dezalgo
98+
[hela]: https://github.com/tunnckoCore/hela
99+
[new-release]: https://github.com/tunnckoCore/new-release
100+
[once]: https://github.com/isaacs/once
101+
[semantic-release]: https://github.com/semantic-release/semantic-release
102+
103+
<!-- Heading badges -->
104+
[npmv-url]: https://www.npmjs.com/package/gitcommit
105+
[npmv-img]: https://img.shields.io/npm/v/gitcommit.svg?label=npm%20version
106+
107+
[github-release-url]: https://github.com/tunnckoCore/gitcommit/releases/latest
108+
[github-release-img]: https://img.shields.io/github/release/tunnckoCore/gitcommit.svg?label=github%20release
109+
110+
[license-url]: https://github.com/tunnckoCore/gitcommit/blob/master/LICENSE
111+
[license-img]: https://img.shields.io/badge/license-Apache%202.0-blue.svg
112+
<!-- [license-img]: https://img.shields.io/badge/license-tunnckoCore_1%2E0-blue.svg -->
113+
114+
<!-- Front line badges -->
115+
[bithound-score-url]: https://www.bithound.io/github/tunnckoCore/gitcommit
116+
[bithound-score-img]: https://www.bithound.io/github/tunnckoCore/gitcommit/badges/score.svg
117+
118+
[bithound-code-url]: https://www.bithound.io/github/tunnckoCore/gitcommit
119+
[bithound-code-img]: https://www.bithound.io/github/tunnckoCore/gitcommit/badges/code.svg
120+
121+
[standard-url]: https://github.com/airbnb/javascript
122+
[standard-img]: https://img.shields.io/badge/code_style-airbnb-brightgreen.svg
123+
124+
[circleci-url]: https://circleci.com/gh/tunnckoCore/gitcommit/tree/master
125+
[circleci-img]: https://img.shields.io/circleci/project/github/tunnckoCore/gitcommit/master.svg
126+
127+
[codecov-url]: https://codecov.io/gh/tunnckoCore/gitcommit
128+
[codecov-img]: https://img.shields.io/codecov/c/github/tunnckoCore/gitcommit/master.svg
129+
130+
[bithound-deps-url]: https://www.bithound.io/github/tunnckoCore/gitcommit/dependencies/npm
131+
[bithound-deps-img]: https://www.bithound.io/github/tunnckoCore/gitcommit/badges/dependencies.svg
132+
133+
[dependencies-url]: https://david-dm.org/tunnckoCore/gitcommit
134+
[dependencies-img]: https://img.shields.io/david/tunnckoCore/gitcommit.svg
135+
136+
<!-- Second front of badges -->
137+
[prs-welcome-img]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
138+
[prs-welcome-url]: http://makeapullrequest.com
139+
140+
[prettier-url]: https://github.com/prettier/prettier
141+
[prettier-img]: https://img.shields.io/badge/styled_with-prettier-f952a5.svg
142+
143+
[nodesecurity-url]: https://nodesecurity.io/orgs/tunnckocore/projects/a3213fd4-9f9a-46a1-a472-055c49331b92/master
144+
[nodesecurity-img]: https://nodesecurity.io/orgs/tunnckocore/projects/a3213fd4-9f9a-46a1-a472-055c49331b92/badge
145+
<!-- the original color of nsp:
146+
[nodesec-img]: https://img.shields.io/badge/nsp-no_known_vulns-35a9e0.svg -->
147+
148+
[ccommits-url]: https://conventionalcommits.org/
149+
[ccommits-img]: https://img.shields.io/badge/conventional_commits-1.0.0-yellow.svg
150+
151+
[new-release-url]: https://github.com/tunnckoCore/new-release
152+
[new-release-img]: https://img.shields.io/badge/semantically-released-05C5FF.svg
153+
154+
[nodeversion-url]: https://nodejs.org/en/download
155+
[nodeversion-img]: https://img.shields.io/node/v/gitcommit.svg
156+
157+
[renovate-url]: https://renovateapp.com
158+
[renovate-img]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg
159+
160+
<!-- Third badges line (After CodeSponsor.io ad) -->
161+
[all-contributors-img]: https://img.shields.io/github/contributors/tunnckoCore/gitcommit.svg?label=all%20contributors&colorB=ffa500
162+
163+
[tinyletter-url]: https://tinyletter.com/tunnckoCore
164+
[tinyletter-img]: https://img.shields.io/badge/join-newsletter-9caaf8.svg
165+
<!--
166+
[paypal-donate-url]: https://paypal.me/tunnckoCore/10
167+
[paypal-donate-img]: https://img.shields.io/badge/$-support-f47721.svg
168+
-->
169+
[give-donate-url]: https://paypal.me/tunnckoCore/10
170+
[give-donate-img]: https://img.shields.io/badge/give-donation-f47721.svg
171+
172+
[downloads-weekly-img]: https://img.shields.io/npm/dw/gitcommit.svg
173+
[downloads-monthly-img]: https://img.shields.io/npm/dm/gitcommit.svg
174+
[downloads-total-img]: https://img.shields.io/npm/dt/gitcommit.svg
175+
176+
<!-- Miscellaneous -->
177+
[share-love-url]: https://twitter.com/intent/tweet?text=https://github.com/Charlike%20Mike%20Reagent/gitcommit&via=tunnckoCore
178+
[share-love-img]: https://img.shields.io/badge/tweet-about-1da1f2.svg
179+
180+
[open-issue-url]: https://github.com/tunnckoCore/gitcommit/issues/new
181+
[highlighted-link]: https://ghub.now.sh/prompts
182+
[author-link]: www.tunnckocore.com
183+

package.json

+10-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "gitcommit",
33
"description": "Lightweight and joyful `git commit` replacement. Conventional Commits compliant.",
4-
"nspId": "todo",
4+
"nspId": "a3213fd4-9f9a-46a1-a472-055c49331b92",
55
"license": "Apache-2.0",
66
"licenseStart": 2018,
77
"scripts": {
@@ -84,6 +84,14 @@
8484
},
8585
"lint": {
8686
"reflinks": true
87-
}
87+
},
88+
"reflinks": [
89+
"always-done",
90+
"dezalgo",
91+
"hela",
92+
"new-release",
93+
"once",
94+
"semantic-release"
95+
]
8896
}
8997
}

0 commit comments

Comments
 (0)