UNPKG

11.8 kBMarkdownView Raw
1# @hela/dev [![npm version][npmv-img]][npmv-url] [![License][license-img]][license-url]
2
3> WIP: Powerful software development experience
4
5Please consider following this project's author, [Charlike Mike Reagent](https://github.com/tunnckoCore), and :star: the project to show your :heart: and support.
6
7<div id="readme"></div>
8
9[![Code style][codestyle-img]][codestyle-url]
10[![CircleCI linux build][linuxbuild-img]][linuxbuild-url]
11[![CodeCov coverage status][codecoverage-img]][codecoverage-url]
12[![DavidDM dependency status][dependencies-img]][dependencies-url]
13[![Renovate App Status][renovateapp-img]][renovateapp-url]
14[![Make A Pull Request][prs-welcome-img]][prs-welcome-url]
15[![Time Since Last Commit][last-commit-img]][last-commit-url]
16
17<!-- [![Semantically Released][standard-release-img]][standard-release-url] -->
18
19If you have any _how-to_ kind of questions, please read the [Contributing Guide][contributing-url] and [Code of Conduct][code_of_conduct-url] documents.
20For bugs reports and feature requests, [please create an issue][open-issue-url] or ping
21[@tunnckoCore](https://twitter.com/tunnckoCore) at Twitter.
22
23[![Conventional Commits][ccommits-img]][ccommits-url]
24[![Minimum Required Nodejs][nodejs-img]][npmv-url]
25[![NPM Downloads Monthly][downloads-monthly-img]][npmv-url]
26[![NPM Downloads Total][downloads-total-img]][npmv-url]
27[![Share Love Tweet][twitter-share-img]][twitter-share-url]
28[![Twitter][twitter-img]][twitter-url]
29
30Project is [semantically](https://semver.org) versioned & automatically released from [GitHub Actions](https://github.com/features/actions) with [Lerna](https://github.com/lerna/lerna).
31
32[![Become a Patron][patreon-img]][patreon-url]
33[![Buy me a Kofi][kofi-img]][kofi-url]
34[![PayPal Donation][paypal-img]][paypal-url]
35[![Bitcoin Coinbase][bitcoin-img]][bitcoin-url]
36[![Keybase PGP][keybase-img]][keybase-url]
37
38| Topic | Contact |
39| :--------------------------------------------------------------- | ------------------------------------------------: |
40| Any legal or licensing questions, like private or commerical use | ![tunnckocore_legal][tunnckocore_legal] |
41| For any critical problems and security reports | ![tunnckocore_security][tunnckocore_security] |
42| Consulting, professional support, personal or team training | ![tunnckocore_consulting][tunnckocore_consulting] |
43| For any questions about Open Source, partnerships and sponsoring | ![tunnckocore_opensource][tunnckocore_opensource] |
44
45<!-- Logo when needed:
46
47<p align="center">
48 <a href="https://github.com/tunnckoCore/opensource">
49 <img src="./media/logo.png" width="85%">
50 </a>
51</p>
52
53-->
54
55## Table of Contents
56
57- [Install](#install)
58- [Contributing](#contributing)
59 - [Guides and Community](#guides-and-community)
60 - [Support the project](#support-the-project)
61 - [OPEN Open Source](#open-open-source)
62 - [Wonderful Contributors](#wonderful-contributors)
63- [License](#license)
64
65_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
66
67## Install
68
69This project requires [**Node.js**](https://nodejs.org) **>=8.11** _(see [Support & Release Policy](https://github.com/tunnckoCoreLabs/support-release-policy))_. Install it using
70[**yarn**](https://yarnpkg.com) or [**npm**](https://npmjs.com).<br>
71_We highly recommend to use Yarn when you think to contribute to this project._
72
73```bash
74$ yarn add @hela/dev
75```
76
77<!-- docks-start -->
78<!-- docks-end -->
79
80**[back to top](#readme)**
81
82## Contributing
83
84### Guides and Community
85
86Please read the [Contributing Guide][contributing-url] and [Code of Conduct][code_of_conduct-url] documents for advices.
87
88For bug reports and feature requests, please join our [community][community-url] forum and open a thread there with prefixing the title of the thread with the name of the project if there's no separate channel for it.
89
90Consider reading the [Support and Release Policy](https://github.com/tunnckoCoreLabs/support-release-policy) guide if you are interested in what are the supported Node.js versions and how we proceed. In short, we support latest two even-numbered Node.js release lines.
91
92### Support the project
93
94[Become a Partner or Sponsor?][patreon-url] :dollar: Check the **Partner**, **Sponsor** or **Omega-level** tiers! :tada: You can get your company logo, link & name on this file. It's also rendered on package page in [npmjs.com][npmv-url] and [yarnpkg.com](https://yarnpkg.com/en/package/@hela/dev) sites too! :rocket:
95
96Not financial support? Okey! [Pull requests](https://github.com/tunnckoCoreLabs/contributing#opening-a-pull-request), stars and all kind of [contributions](https://opensource.guide/how-to-contribute/#what-it-means-to-contribute) are always
97welcome. :sparkles:
98
99<!--
100### OPEN Open Source
101
102This project is following [OPEN Open Source](http://openopensource.org) model
103
104> Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is built on collective efforts and it's not strongly guarded by its founders.
105
106There are a few basic ground-rules for its contributors
107
1081. Any **significant modifications** must be subject to a pull request to get feedback from other contributors.
1092. [Pull requests](https://github.com/tunnckoCoreLabs/contributing#opening-a-pull-request) to get feedback are _encouraged_ for any other trivial contributions, but are not required.
1103. Contributors should attempt to adhere to the prevailing code-style and development workflow.
111-->
112
113### Wonderful Contributors
114
115Thanks to the hard work of these wonderful people this project is alive! It follows the
116[all-contributors](https://github.com/kentcdodds/all-contributors) specification.
117Don't hesitate to add yourself to that list if you have made any contribution! ;) [See how,
118here](https://github.com/jfmengels/all-contributors-cli#usage).
119
120<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
121<!-- prettier-ignore -->
122| [<img src="https://avatars3.githubusercontent.com/u/5038030?v=4" width="120px;"/><br /><sub><b>Charlike Mike Reagent</b></sub>](https://tunnckocore.com)<br />[💻](https://github.com/tunnckoCore/opensource/commits?author=tunnckoCore "Code") [📖](https://github.com/tunnckoCore/opensource/commits?author=tunnckoCore "Documentation") [💬](#question-tunnckoCore "Answering Questions") [👀](#review-tunnckoCore "Reviewed Pull Requests") [🔍](#fundingFinding-tunnckoCore "Funding Finding") |
123| :---: |
124
125<!-- ALL-CONTRIBUTORS-LIST:END -->
126
127Consider showing your [support](#support-the-project) to them. :sparkling_heart:
128
129**[back to top](#readme)**
130
131## License
132
133Copyright (c) 2019-present, [Charlike Mike Reagent](https://tunnckocore.com) `<opensource@tunnckocore.com>` & [contributors](#wonderful-contributors).<br>
134Released under the [MPL-2.0 License][license-url].
135
136[contributing-url]: https://github.com/tunnckoCore/opensource/blob/master/CONTRIBUTING.md
137[code_of_conduct-url]: https://github.com/tunnckoCore/opensource/blob/master/CODE_OF_CONDUCT.md
138
139<!-- Heading badges -->
140
141[npmv-url]: https://www.npmjs.com/package/@hela/dev
142[npmv-img]: https://badgen.net/npm/v/@hela/dev?icon=npm
143[nodejs-img]: https://badgen.net/badge/node/>=8.11/green
144
145<!--
146[ghrelease-url]: https://github.com/tunnckoCore/opensource/releases/latest
147[ghrelease-img]: https://badgen.net/github/release/tunnckoCore/opensource?icon=github
148-->
149
150[license-url]: https://github.com/tunnckoCore/opensource/blob/master/@hela/dev/LICENSE
151[license-img]: https://badgen.net/npm/license/@hela/dev
152
153<!-- Front line badges -->
154
155[codestyle-url]: https://github.com/airbnb/javascript
156[codestyle-img]: https://badgen.net/badge/code%20style/airbnb/ff5a5f?icon=airbnb
157[linuxbuild-url]: https://github.com/tunnckocore/opensource/actions
158[linuxbuild-img]: https://badgennet.charlike-oss.now.sh/github/checks/tunnckoCore/opensource/master?label=build&icon=github
159[codecoverage-url]: https://codecov.io/gh/tunnckoCore/opensource
160[codecoverage-img]: https://badgen.net/badge/coverage/18.33%25/red?icon=codecov
161[dependencies-url]: https://david-dm.org/tunnckoCore/opensource
162[dependencies-img]: https://badgen.net/david/dep/tunnckoCore/opensource?label=deps
163[ccommits-url]: https://conventionalcommits.org/
164[ccommits-img]: https://badgen.net/badge/conventional%20commits/v1.0.0/green
165[standard-release-url]: https://github.com/standard-release/standard-release
166[standard-release-img]: https://badgen.net/badge/semantically/released/05c5ff
167[community-img]: https://badgen.net/badge/join/community/7b16ff
168[community-url]: https://github.com/tunnckocorehq/community
169[last-commit-img]: https://badgen.net/github/last-commit/tunnckoCore/opensource/master
170[last-commit-url]: https://github.com/tunnckoCore/opensource/commits/master
171[downloads-weekly-img]: https://badgen.net/npm/dw/@hela/dev?icon=npm
172[downloads-monthly-img]: https://badgen.net/npm/dm/@hela/dev?icon=npm
173[downloads-total-img]: https://badgen.net/npm/dt/@hela/dev?icon=npm
174[renovateapp-url]: https://renovatebot.com
175[renovateapp-img]: https://badgen.net/badge/renovate/enabled/green
176[prs-welcome-img]: https://badgen.net/badge/PRs/welcome/green
177[prs-welcome-url]: http://makeapullrequest.com
178
179<!-- TODO: update icon -->
180
181[paypal-url]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=HYJJEZNSGAPGC&source=url
182[paypal-img]: https://badgen.net/badge/PayPal/donate/003087?icon=https://simpleicons.now.sh/paypal/fff
183
184<!-- TODO: update icon -->
185
186[kofi-url]: https://ko-fi.com/tunnckoCore
187[kofi-img]: https://badgen.net/badge/Buy%20me/a%20coffee/29abe0c2?icon=https://rawcdn.githack.com/tunnckoCore/badgen-icons/f8264c6414e0bec449dd86f2241d50a9b89a1203/icons/kofi.svg
188
189<!-- TODO: update icon -->
190
191[bitcoin-url]: https://www.blockchain.com/btc/payment_request?address=3QNHKun1K1SUui1b4Z3KEGPPsWC1TgtnqA&message=Open+Source+Software&amount_local=10&currency=USD
192[bitcoin-img]: https://badgen.net/badge/Bitcoin%20tip/3QNHKun...b4Z3KEGPPsWC1TgtnqA/yellow?icon=https://simpleicons.now.sh/bitcoin/fff
193[keybase-url]: https://keybase.io/tunnckoCore
194[keybase-img]: https://badgen.net/keybase/pgp/tunnckoCore
195[twitter-url]: https://twitter.com/tunnckoCore
196[twitter-img]: https://badgen.net/twitter/follow/tunnckoCore?icon=twitter&color=1da1f2
197[patreon-url]: https://www.patreon.com/bePatron?u=5579781
198[patreon-img]: https://badgen.net/badge/Become/a%20patron/F96854?icon=patreon
199
200<!-- [patreon-img]: https://badgen.net/badge/Patreon/tunnckoCore/F96854?icon=patreon -->
201
202[patreon-sponsor-img]: https://badgen.net/badge/become/a%20sponsor/F96854?icon=patreon
203[twitter-share-url]: https://twitter.com/intent/tweet?text=https://github.com/tunnckoCore/opensource/tree/master&via=tunnckoCore
204[twitter-share-img]: https://badgen.net/badge/twitter/share/1da1f2?icon=twitter
205[open-issue-url]: https://github.com/tunnckoCore/opensource/issues/new
206[tunnckocore_legal]: https://badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/legal/tunnckocore?label&color=A56016&icon=https://svgshare.com/i/Dt6.svg
207[tunnckocore_consulting]: https://badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/consulting/tunnckocore?label&color=07ba96&icon=https://svgshare.com/i/Dt6.svg
208[tunnckocore_security]: https://badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/security/tunnckocore?label&color=ed1848&icon=https://svgshare.com/i/Dt6.svg
209[tunnckocore_opensource]: https://badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/opensource/tunnckocore?label&color=ff7a2f&icon=https://svgshare.com/i/Dt6.svg
210[tunnckocore_newsletter]: https://badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/newsletter/tunnckocore?label&color=5199FF&icon=https://svgshare.com/i/Dt6.svg