Skip to content

Commit

Permalink
Merge pull request eventOneHQ#28 from SirFredric/patch-1
Browse files Browse the repository at this point in the history
Made it flashier
  • Loading branch information
nprail authored Oct 15, 2019
2 parents e09e892 + 4d77a32 commit e875fb3
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,23 @@
</p>
<p align="center"><b>Generate a HTML report for NPM Audit</b></p>

## Install
## πŸ“ Table of Contents

- [Getting Started](#getting_started)
- [Usage](#usage)
- [Contributing](CONTRIBUTING.md)
- [Authors](#authors)
- [Acknowledgments](#acknowledgement)

## 🏁 Getting Started <a name = "getting_started"></a>

```
$ npm install -g npm-audit-html
```

> This package uses async/await and requires Node.js 7.6
## Usage
## 🎈 Usage <a name="usage"></a>

To generate a report, run the following:

Expand All @@ -35,9 +43,15 @@ If you want to specify the output file, add the `--output` option:
npm audit --json | npm-audit-html --output report.html
```

## Contributors
## ✍️ Authors <a name = "authors"></a>

- [@nprail](https://github.com/nprail) - Maintainer

See also the list of [contributors](https://github.com/eventOneHQ/npm-audit-html/contributors) who participated in this project.

## πŸŽ‰ Acknowledgements <a name = "acknowledgement"></a>

[![](https://sourcerer.io/fame/nprail/Filiosoft/npm-audit-html/images/0)](https://sourcerer.io/fame/nprail/Filiosoft/npm-audit-html/links/0)[![](https://sourcerer.io/fame/nprail/Filiosoft/npm-audit-html/images/1)](https://sourcerer.io/fame/nprail/Filiosoft/npm-audit-html/links/1)[![](https://sourcerer.io/fame/nprail/Filiosoft/npm-audit-html/images/2)](https://sourcerer.io/fame/nprail/Filiosoft/npm-audit-html/links/2)[![](https://sourcerer.io/fame/nprail/Filiosoft/npm-audit-html/images/3)](https://sourcerer.io/fame/nprail/Filiosoft/npm-audit-html/links/3)[![](https://sourcerer.io/fame/nprail/Filiosoft/npm-audit-html/images/4)](https://sourcerer.io/fame/nprail/Filiosoft/npm-audit-html/links/4)[![](https://sourcerer.io/fame/nprail/Filiosoft/npm-audit-html/images/5)](https://sourcerer.io/fame/nprail/Filiosoft/npm-audit-html/links/5)[![](https://sourcerer.io/fame/nprail/Filiosoft/npm-audit-html/images/6)](https://sourcerer.io/fame/nprail/Filiosoft/npm-audit-html/links/6)[![](https://sourcerer.io/fame/nprail/Filiosoft/npm-audit-html/images/7)](https://sourcerer.io/fame/nprail/Filiosoft/npm-audit-html/links/7)
- Hat tip to anyone whose code was used

## License

Expand Down

0 comments on commit e875fb3

Please sign in to comment.