From c18fcba54e6e256551bded3c35f954bf7bddf448 Mon Sep 17 00:00:00 2001 From: Lars Kappert Date: Mon, 17 Jun 2024 10:30:05 +0200 Subject: [PATCH] Update readme with badges and stuff --- README.md | 44 ++++++++++++++++++++++++++++------------- packages/knip/README.md | 42 ++++++++++++++++++++++++++++++--------- 2 files changed, 63 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 13223978..300f6bf6 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,43 @@ -# ✂️ Knip +

+
+ + Knip + +
+
+

-Hi there! +
-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]. +
-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 diff --git a/packages/knip/README.md b/packages/knip/README.md index 3fd13de8..300f6bf6 100644 --- a/packages/knip/README.md +++ b/packages/knip/README.md @@ -1,19 +1,43 @@ -# ✂️ Knip +

+
+ + Knip + +
+
+

-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. +
-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]. +
+ +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