Skip to content

Commit

Permalink
Update readme with badges and stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
webpro committed Jun 17, 2024
1 parent e10ac2e commit c18fcba
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 23 deletions.
44 changes: 30 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,43 @@
# ✂️ Knip
<h1 align="center">
<br>
<a href="https://knip.dev">
<img height="200" width="200" src="https://knip.dev/favicon.svg" alt="Knip" />
</a>
<br>
<br>
</h1>

Hi there!
<div align="center">

Knip finds **unused files, dependencies and exports** in your JavaScript and TypeScript projects. Less code and
dependencies lead to improved performance, less maintenance and easier refactorings.
[![NPM Version](https://img.shields.io/npm/v/knip)][1]
[![NPM Downloads](https://img.shields.io/npm/dm/knip)][1]
[![GitHub Repo stars](https://img.shields.io/github/stars/webpro-nl/knip)][2]

The documentation is available at [knip.dev][1].
</div>

This repository contains the source code of the [knip package][2] and the content for the [documentation website][1].
Knip finds **unused files, dependencies and exports** in your JavaScript and
TypeScript projects. Less code and dependencies lead to improved performance,
less maintenance and easier refactorings.

Contributions welcome! If you'd like to contribute, please start by reading the [contributing guide][3].

Do you feel lost? Feel free to join [Knip's Discord channel][4].
- Website: [knip.dev][3]
- GitHub repo: [webpro-nl/knip][2]
- npm package: [knip][1]
- [Discord][4]
- [Contributing Guide][5]
- [Sponsor Knip!][6]

## Contributors

Special thanks to the wonderful people who have contributed to this project:

[![Contributors][6]][5]
[![Contributors][8]][7]

[1]: https://knip.dev
[2]: https://www.npmjs.com/package/knip
[3]: https://github.com/webpro-nl/knip/blob/main/.github/CONTRIBUTING.md
[1]: https://www.npmjs.com/package/knip
[2]: https://github.com/webpro-nl/knip
[3]: https://knip.dev
[4]: https://discord.gg/r5uXTtbTpc
[5]: https://github.com/webpro-nl/knip/graphs/contributors
[6]: https://contrib.rocks/image?repo=webpro-nl/knip
[5]: https://github.com/webpro-nl/knip/blob/main/.github/CONTRIBUTING.md
[6]: https://knip.dev/sponsors
[7]: https://github.com/webpro-nl/knip/graphs/contributors
[8]: https://contrib.rocks/image?repo=webpro-nl/knip
42 changes: 33 additions & 9 deletions packages/knip/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,43 @@
# ✂️ Knip
<h1 align="center">
<br>
<a href="https://knip.dev">
<img height="200" width="200" src="https://knip.dev/favicon.svg" alt="Knip" />
</a>
<br>
<br>
</h1>

Knip finds **unused files, dependencies and exports** in your JavaScript and TypeScript projects. Less code and
dependencies lead to improved performance, less maintenance and easier refactorings.
<div align="center">

The documentation is available at [knip.dev][1].
[![NPM Version](https://img.shields.io/npm/v/knip)][1]
[![NPM Downloads](https://img.shields.io/npm/dm/knip)][1]
[![GitHub Repo stars](https://img.shields.io/github/stars/webpro-nl/knip)][2]

This package is part of [the Knip monorepo][2].
</div>

Knip finds **unused files, dependencies and exports** in your JavaScript and
TypeScript projects. Less code and dependencies lead to improved performance,
less maintenance and easier refactorings.


- Website: [knip.dev][3]
- GitHub repo: [webpro-nl/knip][2]
- npm package: [knip][1]
- [Discord][4]
- [Contributing Guide][5]
- [Sponsor Knip!][6]

## Contributors

Special thanks to the wonderful people who have contributed to this project:

[![Contributors][4]][3]
[![Contributors][8]][7]

[1]: https://knip.dev
[1]: https://www.npmjs.com/package/knip
[2]: https://github.com/webpro-nl/knip
[3]: https://github.com/webpro-nl/knip/graphs/contributors
[4]: https://contrib.rocks/image?repo=webpro-nl/knip
[3]: https://knip.dev
[4]: https://discord.gg/r5uXTtbTpc
[5]: https://github.com/webpro-nl/knip/blob/main/.github/CONTRIBUTING.md
[6]: https://knip.dev/sponsors
[7]: https://github.com/webpro-nl/knip/graphs/contributors
[8]: https://contrib.rocks/image?repo=webpro-nl/knip

0 comments on commit c18fcba

Please sign in to comment.