-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Charlike Mike Reagent <olsten.larck@gmail.com>
- Loading branch information
Charlike Mike Reagent
committed
Jun 9, 2018
1 parent
d7b5e75
commit 813b287
Showing
3 changed files
with
246 additions
and
3 deletions.
There are no files selected for viewing
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,120 @@ | ||
# xaxa [![npm version][npmv-img]][npmv-url] [![github release][ghrelease-img]][ghrelease-url] [![License][license-img]][license-url] | ||
|
||
<p align="center"> | ||
<a href="https://github.com/olstenlarck/xaxa"> | ||
<img src="./logo.png"> | ||
</a> | ||
</p> | ||
<br> | ||
|
||
> :star2: Zero-config linting, powered by few amazing unicorns :unicorn:, [AirBnB](https://github.com/airbnb/javascript) :revolving_hearts: & [Prettier](https://prettier.io/) :tada: | ||
[![XAXA code style][codestyle-img]][codestyle-url] | ||
[![CircleCI linux build][linuxbuild-img]][linuxbuild-url] | ||
[![CodeCov coverage status][codecoverage-img]][codecoverage-url] | ||
[![DavidDM dependency status][dependencies-img]][dependencies-url] | ||
[![Renovate App Status][renovateapp-img]][renovateapp-url] | ||
[![Make A Pull Request][prs-welcome-img]][prs-welcome-url] | ||
|
||
If you have any _how-to_ kind of questions, please read the [Contributing Guide](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) documents. | ||
For bugs reports and feature requests, [please create an issue][open-issue-url] or ping [@tunnckoCore](https://twitter.com/tunnckoCore) at Twitter. | ||
|
||
[![Conventional Commits][ccommits-img]][ccommits-url] | ||
[![PayPal Author Support][paypal-donate-img]][paypal-donate-url] | ||
[![Share Love Tweet][share-love-img]][share-love-url] | ||
[![NPM Downloads Weekly][downloads-weekly-img]][npmv-url] | ||
[![NPM Downloads Monthly][downloads-monthly-img]][npmv-url] | ||
[![NPM Downloads Total][downloads-total-img]][npmv-url] | ||
|
||
Project is [semantically](https://semver.org) & automatically released on [CircleCI][codecoverage-url] with [new-release][] and its [New Release](https://github.com/apps/new-release) Github App. | ||
|
||
## Table of Contents | ||
<!-- toc --> | ||
|
||
## Install | ||
|
||
This project requires [**Node.js**][nodeversion-url] **{%= engines.node %}**. Install it using [**yarn**](https://yarnpkg.com). | ||
|
||
```bash | ||
$ yarn add {%= name %} --dev | ||
|
||
# or globally | ||
$ yarn global add {%= name %} | ||
|
||
# and just run it | ||
$ {%= name %} | ||
``` | ||
|
||
## API | ||
{%= apidocs('src/index.mjs') %} | ||
|
||
**[back to top](#thetop)** | ||
|
||
{% if (verb.related && verb.related.list && verb.related.list.length) { %} | ||
## Related Projects | ||
Some of these projects are used here or were inspiration for this one, others are just related. So, thanks for your existance! | ||
{%= related(verb.related.list, { words: 12 }) %} | ||
|
||
**[back to top](#thetop)** | ||
{% } %} | ||
|
||
|
||
## Contributing | ||
Please read the [Contributing Guide](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) documents for advices. | ||
For bugs reports and feature requests, [please create an issue][open-issue-url] or ping [@tunnckoCore](https://twitter.com/tunnckoCore) at Twitter. | ||
|
||
## License | ||
Copyright (c) {%= licenseStart %}-present, [Charlike Mike Reagent][author-link] `<olsten.larck@gmail.com>`. | ||
Released under the [{%= license %} License][license-url]. | ||
|
||
*** | ||
|
||
{%= include('footer') %} | ||
|
||
<!-- Heading badges --> | ||
[npmv-url]: https://www.npmjs.com/package/{%= name %} | ||
[npmv-img]: https://img.shields.io/npm/v/{%= name %}.svg?label=npm%20version | ||
|
||
[ghrelease-url]: https://github.com/{%= repository %}/releases/latest | ||
[ghrelease-img]: https://img.shields.io/github/release/{%= repository %}.svg?label=github%20release | ||
|
||
[license-url]: https://github.com/{%= repository %}/blob/master/LICENSE | ||
[license-img]: https://img.shields.io/badge/license-{%= license.replace('-', '%20') %}-blue.svg | ||
|
||
<!-- Front line badges --> | ||
|
||
[codestyle-url]: https://github.com/olstenlarck/xaxa | ||
[codestyle-img]: https://img.shields.io/badge/code_style-xaxa-brightgreen.svg | ||
|
||
[linuxbuild-url]: https://circleci.com/gh/{%= repository %}/tree/master | ||
[linuxbuild-img]: https://img.shields.io/circleci/project/github/{%= repository %}/master.svg | ||
|
||
[codecoverage-url]: https://codecov.io/gh/{%= repository %} | ||
[codecoverage-img]: https://img.shields.io/codecov/c/github/{%= repository %}/master.svg | ||
|
||
[dependencies-url]: https://david-dm.org/{%= repository %} | ||
[dependencies-img]: https://img.shields.io/david/{%= repository %}.svg | ||
|
||
[ccommits-url]: https://conventionalcommits.org/ | ||
[ccommits-img]: https://img.shields.io/badge/conventional_commits-1.0.0-yellow.svg | ||
|
||
[new-release-url]: https://github.com/tunnckoCore/new-release | ||
[new-release-img]: https://img.shields.io/badge/semantically-released-05C5FF.svg | ||
|
||
[downloads-weekly-img]: https://img.shields.io/npm/dw/{%= name %}.svg | ||
[downloads-monthly-img]: https://img.shields.io/npm/dm/{%= name %}.svg | ||
[downloads-total-img]: https://img.shields.io/npm/dt/{%= name %}.svg | ||
|
||
[renovateapp-url]: https://renovatebot.com | ||
[renovateapp-img]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg | ||
|
||
[prs-welcome-img]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg | ||
[prs-welcome-url]: http://makeapullrequest.com | ||
|
||
[paypal-donate-url]: https://paypal.me/tunnckoCore/10 | ||
[paypal-donate-img]: https://img.shields.io/badge/$-support-f47721.svg | ||
|
||
[share-love-url]: https://twitter.com/intent/tweet?text=https://github.com/{%= repository %}&via=tunnckoCore | ||
[share-love-img]: https://img.shields.io/badge/twitter-share-1da1f2.svg | ||
[open-issue-url]: https://github.com/{%= repository %}/issues/new | ||
[author-link]: https://i.am.charlike.online |
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 |
---|---|---|
@@ -1,11 +1,118 @@ | ||
# xaxa [![npm version][npmv-img]][npmv-url] [![github release][ghrelease-img]][ghrelease-url] [![License][license-img]][license-url] | ||
|
||
<p align="center"> | ||
<a href="https://github.com/olstenlarck/xaxa"> | ||
<img src="./logo.png"> | ||
</a> | ||
</p> | ||
<br> | ||
|
||
# xaxa | ||
> :star2: Zero-config linting, powered by few amazing unicorns :unicorn:, [AirBnB](https://github.com/airbnb/javascript) :revolving_hearts: & [Prettier](https://prettier.io/) :tada: | ||
[![XAXA code style][codestyle-img]][codestyle-url] | ||
[![CircleCI linux build][linuxbuild-img]][linuxbuild-url] | ||
[![CodeCov coverage status][codecoverage-img]][codecoverage-url] | ||
[![DavidDM dependency status][dependencies-img]][dependencies-url] | ||
[![Renovate App Status][renovateapp-img]][renovateapp-url] | ||
[![Make A Pull Request][prs-welcome-img]][prs-welcome-url] | ||
|
||
If you have any _how-to_ kind of questions, please read the [Contributing Guide](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) documents. | ||
For bugs reports and feature requests, [please create an issue][open-issue-url] or ping [@tunnckoCore](https://twitter.com/tunnckoCore) at Twitter. | ||
|
||
[![Conventional Commits][ccommits-img]][ccommits-url] | ||
[![PayPal Author Support][paypal-donate-img]][paypal-donate-url] | ||
[![Share Love Tweet][share-love-img]][share-love-url] | ||
[![NPM Downloads Weekly][downloads-weekly-img]][npmv-url] | ||
[![NPM Downloads Monthly][downloads-monthly-img]][npmv-url] | ||
[![NPM Downloads Total][downloads-total-img]][npmv-url] | ||
|
||
Project is [semantically](https://semver.org) & automatically released on [CircleCI][codecoverage-url] with [new-release][] and its [New Release](https://github.com/apps/new-release) Github App. | ||
|
||
## Table of Contents | ||
- [Install](#install) | ||
- [API](#api) | ||
- [Related Projects](#related-projects) | ||
- [Contributing](#contributing) | ||
- [License](#license) | ||
|
||
_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_ | ||
|
||
## Install | ||
|
||
This project requires [**Node.js**][nodeversion-url] **^8.9.0 || ^10.3.0**. Install it using [**yarn**](https://yarnpkg.com). | ||
|
||
```bash | ||
$ yarn add xaxa --dev | ||
|
||
# or globally | ||
$ yarn global add xaxa | ||
|
||
# and just run it | ||
$ xaxa | ||
``` | ||
|
||
## API | ||
|
||
**[back to top](#thetop)** | ||
|
||
## Contributing | ||
Please read the [Contributing Guide](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) documents for advices. | ||
For bugs reports and feature requests, [please create an issue][open-issue-url] or ping [@tunnckoCore](https://twitter.com/tunnckoCore) at Twitter. | ||
|
||
## License | ||
Copyright (c) 2018-present, [Charlike Mike Reagent][author-link] `<olsten.larck@gmail.com>`. | ||
Released under the [Apache-2.0 License][license-url]. | ||
|
||
*** | ||
|
||
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.7.0, on June 09, 2018._ | ||
|
||
<!-- Heading badges --> | ||
[npmv-url]: https://www.npmjs.com/package/xaxa | ||
[npmv-img]: https://img.shields.io/npm/v/xaxa.svg?label=npm%20version | ||
|
||
[ghrelease-url]: https://github.com/olstenlarck/xaxa/releases/latest | ||
[ghrelease-img]: https://img.shields.io/github/release/olstenlarck/xaxa.svg?label=github%20release | ||
|
||
[license-url]: https://github.com/olstenlarck/xaxa/blob/master/LICENSE | ||
[license-img]: https://img.shields.io/badge/license-Apache%202.0-blue.svg | ||
|
||
<!-- Front line badges --> | ||
|
||
[codestyle-url]: https://github.com/olstenlarck/xaxa | ||
[codestyle-img]: https://img.shields.io/badge/code_style-xaxa-brightgreen.svg | ||
|
||
[linuxbuild-url]: https://circleci.com/gh/olstenlarck/xaxa/tree/master | ||
[linuxbuild-img]: https://img.shields.io/circleci/project/github/olstenlarck/xaxa/master.svg | ||
|
||
[codecoverage-url]: https://codecov.io/gh/olstenlarck/xaxa | ||
[codecoverage-img]: https://img.shields.io/codecov/c/github/olstenlarck/xaxa/master.svg | ||
|
||
[dependencies-url]: https://david-dm.org/olstenlarck/xaxa | ||
[dependencies-img]: https://img.shields.io/david/olstenlarck/xaxa.svg | ||
|
||
[ccommits-url]: https://conventionalcommits.org/ | ||
[ccommits-img]: https://img.shields.io/badge/conventional_commits-1.0.0-yellow.svg | ||
|
||
[new-release-url]: https://github.com/tunnckoCore/new-release | ||
[new-release-img]: https://img.shields.io/badge/semantically-released-05C5FF.svg | ||
|
||
[downloads-weekly-img]: https://img.shields.io/npm/dw/xaxa.svg | ||
[downloads-monthly-img]: https://img.shields.io/npm/dm/xaxa.svg | ||
[downloads-total-img]: https://img.shields.io/npm/dt/xaxa.svg | ||
|
||
[renovateapp-url]: https://renovatebot.com | ||
[renovateapp-img]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg | ||
|
||
[prs-welcome-img]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg | ||
[prs-welcome-url]: http://makeapullrequest.com | ||
|
||
[paypal-donate-url]: https://paypal.me/tunnckoCore/10 | ||
[paypal-donate-img]: https://img.shields.io/badge/$-support-f47721.svg | ||
|
||
[share-love-url]: https://twitter.com/intent/tweet?text=https://github.com/olstenlarck/xaxa&via=tunnckoCore | ||
[share-love-img]: https://img.shields.io/badge/twitter-share-1da1f2.svg | ||
[open-issue-url]: https://github.com/olstenlarck/xaxa/issues/new | ||
[author-link]: https://i.am.charlike.online | ||
|
||
## TODO | ||
[new-release]: https://github.com/tunnckoCore/new-release |
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