Skip to content
This repository has been archived by the owner on Nov 20, 2019. It is now read-only.

Commit

Permalink
fix(docs): generate readme, add nsp id
Browse files Browse the repository at this point in the history
Signed-off-by: Charlike Mike Reagent <[email protected]>
  • Loading branch information
Charlike Mike Reagent committed Nov 14, 2017
1 parent bd3d178 commit 6dfd869
Show file tree
Hide file tree
Showing 2 changed files with 191 additions and 3 deletions.
185 changes: 185 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
# new-release [![npm version][npmv-img]][npmv-url] [![github release][github-release-img]][github-release-url] [![License][license-img]][license-url]

> A stable alternative to [semantic-release][]. Only handles NPM publishing and nothing more. For creating GitHub releases use the Semantic Release GitHub App
<div id="thetop"></div>

_You might also be interested in [execa][highlighted-link] or in the other [related projects](#related-projects)._

## Quality Assurance :100:

[![bitHound Code][bithound-code-img]][bithound-code-url]
[![Code Style Standard][standard-img]][standard-url]
[![Linux Build][circleci-img]][circleci-url]
[![Code Coverage][codecov-img]][codecov-url]
[![bitHound Score][bithound-score-img]][bithound-score-url]
[![bitHound Deps][bithound-deps-img]][bithound-deps-url]
[![Dependencies Status][dependencies-img]][dependencies-url]

If you have any _how-to_ kind of questions, please read [Code of Conduct](./CODE_OF_CONDUCT.md) and **join the chat** rooms or [open an issue][open-issue-url].
You may also read the [Contributing Guide](./CONTRIBUTING.md). There, beside _"How to contribute?"_, we describe everything **_stated_** by the badges.

[![tunnckoCore support][chat-img]][chat-url]
[![Code Format Prettier][prettier-img]][prettier-url]
[![Node Security Status][nodesecurity-img]][nodesecurity-url]
[![Conventional Commits][ccommits-img]][ccommits-url]
[![Make A Pull Request][prs-welcome-img]][prs-welcome-url]
[![Node Version Required][nodeversion-img]][nodeversion-url]
[![Renovate App Status][renovate-img]][renovate-url]

<a target="_blank" rel="nofollow" href="https://app.codesponsor.io/link/K7yYzzA5nb2ZDR4GTKmgUdfe/tunnckoCore/new-release">
<img alt="Sponsor" width="888" height="68" src="https://app.codesponsor.io/embed/K7yYzzA5nb2ZDR4GTKmgUdfe/tunnckoCore/new-release.svg" />
</a>
<p></p>

[![All Contributors Spec][all-contributors-img]](#contributors)
[![Make A Pull Request][prs-welcome-img]][prs-welcome-url]
[![Newsletter Subscribe][tinyletter-img]][tinyletter-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]

## Table of Contents
- [Install](#install)
- [API](#api)
- [Related Projects](#related-projects)
- [Contributing](#contributing)
- [Contributors](#contributors)
- [Users](#users)
- [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] **v8** or above. Install it using [**yarn**](https://yarnpkg.com) **v1** or above / [**npm**](https://www.npmjs.com) **v5** or above.

```
$ yarn add new-release
```
<!--
A browser usage is also possible, thanks to the [unpkg.com](https://unpkg.com) CDN and [Rollup](https://ghub.now.sh/rollup) bundler.
See available bundles at [`https://unpkg.com/new-release/dist/browser/`](https://unpkg.com/new-release/dist/browser/).
> _**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._
-->

## API
Review carefully the provided examples and the working [tests](./test).

**[back to top](#thetop)**

## Related Projects
Some of these projects are used here or were inspiration for this one, others are just related. So, thanks for your existance!
- [dush](https://www.npmjs.com/package/dush): Microscopic & functional event emitter in ~350 bytes, extensible through plugins | [homepage](https://github.com/tunnckocore/dush#readme "Microscopic & functional event emitter in ~350 bytes, extensible through plugins")
- [execa](https://www.npmjs.com/package/execa): A better `child_process` | [homepage](https://github.com/sindresorhus/execa#readme "A better `child_process`")
- [hela](https://www.npmjs.com/package/hela): Powerful & flexible task runner framework in 80 lines, based on execa… [more](https://github.com/tunnckoCore/hela#readme) | [homepage](https://github.com/tunnckoCore/hela#readme "Powerful & flexible task runner framework in 80 lines, based on execa. Supports presets, a la ESLint but for tasks & npm scripts")
- [mri](https://www.npmjs.com/package/mri): Quickly scan for CLI flags and arguments | [homepage](https://github.com/lukeed/mri#readme "Quickly scan for CLI flags and arguments")
- [p-map-series](https://www.npmjs.com/package/p-map-series): Map over promises serially | [homepage](https://github.com/sindresorhus/p-map-series#readme "Map over promises serially")

**[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 join us at our [Flock chat][chat-url] rooms.

## Contributors
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.
[Pull requests](./CONTRIBUTING.md#opening-a-pull-request), stars and all kind of [contributions](https://opensource.guide/how-to-contribute/#what-it-means-to-contribute) are always welcome.

## Users
You can see who uses `new-release` in the [USERS.md](./USERS.md) file. Please feel free adding this file if it not exists.
If you or your organization are using this project, consider adding yourself to the list of users. **Thank You!**

## License
Copyright (c) 2017-present, [Charlike Mike Reagent][author-link] `<[email protected]>`.
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.6.0, on November 14, 2017._
_Project scaffolded and managed with [hela][]._

<!-- Heading badges -->
[npmv-url]: https://www.npmjs.com/package/new-release
[npmv-img]: https://img.shields.io/npm/v/new-release.svg?label=npm%20version

[github-release-url]: https://github.com/tunnckoCore/new-release/releases/latest
[github-release-img]: https://img.shields.io/github/release/tunnckoCore/new-release.svg?label=github%20release

[license-url]: https://github.com/tunnckoCore/new-release/blob/master/LICENSE
[license-img]: https://img.shields.io/npm/l/new-release.svg
<!-- [license-img]: https://img.shields.io/badge/license-tunnckoCore_1%2E0-blue.svg -->

[downloads-monthly-img]: https://img.shields.io/npm/dm/new-release.svg

<!-- Front line badges -->
[bithound-score-url]: https://www.bithound.io/github/tunnckoCore/new-release
[bithound-score-img]: https://www.bithound.io/github/tunnckoCore/new-release/badges/score.svg

[bithound-code-url]: https://www.bithound.io/github/tunnckoCore/new-release
[bithound-code-img]: https://www.bithound.io/github/tunnckoCore/new-release/badges/code.svg

[standard-url]: https://github.com/airbnb/javascript
[standard-img]: https://img.shields.io/badge/code_style-airbnb-brightgreen.svg

[circleci-url]: https://circleci.com/gh/tunnckoCore/new-release/tree/master
[circleci-img]: https://img.shields.io/circleci/project/github/tunnckoCore/new-release/master.svg

[codecov-url]: https://codecov.io/gh/tunnckoCore/new-release
[codecov-img]: https://img.shields.io/codecov/c/github/tunnckoCore/new-release/master.svg

[bithound-deps-url]: https://www.bithound.io/github/tunnckoCore/new-release/dependencies/npm
[bithound-deps-img]: https://www.bithound.io/github/tunnckoCore/new-release/badges/dependencies.svg

[dependencies-url]: https://david-dm.org/tunnckoCore/new-release
[dependencies-img]: https://img.shields.io/david/tunnckoCore/new-release.svg

<!-- Second front of badges -->
[chat-url]: https://tunnckocore.flock.com/?i=cx2xoeofjtj6eo6c
[chat-img]: https://img.shields.io/badge/chat-on_flock-brightgreen.svg

[prettier-url]: https://github.com/prettier/prettier
[prettier-img]: https://img.shields.io/badge/styled_with-prettier-f952a5.svg

[nodesecurity-url]: https://nodesecurity.io/orgs/tunnckocore/projects/12907c4a-78a2-41d7-a430-49396e68b9cd/master
[nodesecurity-img]: https://nodesecurity.io/orgs/tunnckocore/projects/12907c4a-78a2-41d7-a430-49396e68b9cd/badge
<!-- the original color of nsp:
[nodesec-img]: https://img.shields.io/badge/nsp-no_known_vulns-35a9e0.svg -->

[ccommits-url]: https://conventionalcommits.org/
[ccommits-img]: https://img.shields.io/badge/conventional_commits-1.0.0-yellow.svg

[prs-welcome-img]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
[prs-welcome-url]: http://makeapullrequest.com

[nodeversion-url]: https://nodejs.org/en/download
[nodeversion-img]: https://img.shields.io/node/v/new-release.svg

[renovate-url]: https://renovateapp.com
[renovate-img]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg

<!-- Third badges line (After CodeSponsor ads) -->
[all-contributors-img]: https://img.shields.io/github/contributors/tunnckoCore/new-release.svg?label=all%20contributors&colorB=ffa500

[tinyletter-url]: https://tinyletter.com/tunnckoCore
[tinyletter-img]: https://img.shields.io/badge/join-newsletter-9caaf8.svg

[paypal-donate-url]: https://paypal.me/tunnckoCore/10
[paypal-donate-img]: https://img.shields.io/badge/$-support-f47721.svg

[downloads-weekly-img]: https://img.shields.io/npm/dw/new-release.svg
[downloads-total-img]: https://img.shields.io/npm/dt/new-release.svg

<!-- Miscellaneous -->
[share-love-url]: https://twitter.com/intent/tweet?text=https://github.com/tunnckoCore/new-release&via=tunnckoCore
[share-love-img]: https://img.shields.io/badge/share-love-1da1f2.svg
[open-issue-url]: https://github.com/tunnckoCore/new-release/issues/new

[highlighted-link]: https://ghub.now.sh/execa
[author-link]: https://i.am.charlike.online

[hela]: https://github.com/tunnckoCore/hela
[semantic-release]: https://github.com/semantic-release/semantic-release
9 changes: 6 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "A stable alternative to [semantic-release][]. Only handles NPM publishing and nothing more. For creating GitHub releases use the Semantic Release GitHub App",
"repository": "tunnckoCore/new-release",
"author": "Charlike Mike Reagent (https://i.am.charlike.online)",
"nspId": "todo",
"nspId": "12907c4a-78a2-41d7-a430-49396e68b9cd",
"main": "./src/index.js",
"scripts": {
"test": "NODE_ENV=test yarn hela test",
Expand Down Expand Up @@ -63,6 +63,9 @@
"lint": {
"reflinks": true
},
"reflinks": []
"reflinks": [
"hela",
"semantic-release"
]
}
}
}

0 comments on commit 6dfd869

Please sign in to comment.