Skip to content

Commit

Permalink
docs: Rebuilt readme with tldw
Browse files Browse the repository at this point in the history
  • Loading branch information
Jaid committed Jan 12, 2020
1 parent c08f4bb commit 09881aa
Showing 1 changed file with 41 additions and 3 deletions.
44 changes: 41 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,59 @@
# pkg-banner-webpack-plugin


Webpack plugin that prepends output with a license comment based on package.json values.
<a href="https://raw.githubusercontent.com/Jaid/pkg-banner-webpack-plugin/master/license.txt"><img src="https://img.shields.io/github/license/Jaid/pkg-banner-webpack-plugin?style=flat-square" alt="License"/></a>
<a href="https://actions-badge.atrox.dev/Jaid/pkg-banner-webpack-plugin/goto"><img src="https://img.shields.io/endpoint.svg?style=flat-square&url=https%3A%2F%2Factions-badge.atrox.dev%2FJaid%2Fpkg-banner-webpack-plugin%2Fbadge" alt="Build status"/></a> <a href="https://github.com/Jaid/pkg-banner-webpack-plugin/commits"><img src="https://img.shields.io/github/commits-since/Jaid/pkg-banner-webpack-plugin/v1.0.0?style=flat-square&logo=github" alt="Commits since v1.0.0"/></a> <a href="https://github.com/Jaid/pkg-banner-webpack-plugin/commits"><img src="https://img.shields.io/github/last-commit/Jaid/pkg-banner-webpack-plugin?style=flat-square&logo=github" alt="Last commit"/></a> <a href="https://github.com/Jaid/pkg-banner-webpack-plugin/issues"><img src="https://img.shields.io/github/issues/Jaid/pkg-banner-webpack-plugin?style=flat-square&logo=github" alt="Issues"/></a>
<a href="https://npmjs.com/package/pkg-banner-webpack-plugin"><img src="https://img.shields.io/npm/v/pkg-banner-webpack-plugin?style=flat-square&logo=npm&label=latest%20version" alt="Latest version on npm"/></a> <a href="https://github.com/Jaid/pkg-banner-webpack-plugin/network/dependents"><img src="https://img.shields.io/librariesio/dependents/npm/pkg-banner-webpack-plugin?style=flat-square&logo=npm" alt="Dependents"/></a> <a href="https://npmjs.com/package/pkg-banner-webpack-plugin"><img src="https://img.shields.io/npm/dm/pkg-banner-webpack-plugin?style=flat-square&logo=npm" alt="Downloads"/></a>

**Webpack plugin that prepends output with a license comment based on package.json values.**















## Installation
<a href='https://npmjs.com/package/pkg-banner-webpack-plugin'><img alt='npm logo' src='https://github.com/Jaid/action-readme/raw/master/images/base-assets/npm.png'/></a>
<a href="https://npmjs.com/package/pkg-banner-webpack-plugin"><img src="https://img.shields.io/badge/npm-pkg--banner--webpack--plugin-C23039?style=flat-square&logo=npm" alt="pkg-banner-webpack-plugin on npm"/></a>
```bash
npm install --save-dev pkg-banner-webpack-plugin@^1.0.0
```
<a href='https://yarnpkg.com/package/pkg-banner-webpack-plugin'><img alt='Yarn logo' src='https://github.com/Jaid/action-readme/raw/master/images/base-assets/yarn.png'/></a>
<a href="https://yarnpkg.com/package/pkg-banner-webpack-plugin"><img src="https://img.shields.io/badge/Yarn-pkg--banner--webpack--plugin-2F8CB7?style=flat-square&logo=yarn&logoColor=white" alt="pkg-banner-webpack-plugin on Yarn"/></a>
```bash
yarn add --dev pkg-banner-webpack-plugin@^1.0.0
```








## Development



Setting up:
```bash
git clone git@github.com:Jaid/pkg-banner-webpack-plugin.git
cd pkg-banner-webpack-plugin
npm install
```
Testing in production environment:
```bash
npm run test
```


## License
```text
MIT License
Expand Down

0 comments on commit 09881aa

Please sign in to comment.