Skip to content

Refine README.md #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
charpeni merged 1 commit into from
Jul 4, 2025
Merged

Refine README.md #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 20 additions & 47 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,66 +1,39 @@
<div align="center">
<a href="http://bundlewatch.io">
<img src="https://cdn.rawgit.com/bundlewatch/bundlewatch.io/master/docs/_assets/logo-large.svg" height="100px">
<img src="https://cdn.rawgit.com/bundlewatch/bundlewatch.io/master/docs/_assets/logo-large.svg" width="600px">
</a>
<br>
<br>

[![bundlewatch][bundlewatch]][bundlewatch-url]
[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors)
<br>
<a href="https://github.com/bundlewatch/bundlewatch.io/graphs/contributors">
<img src="https://img.shields.io/github/contributors/bundlewatch/bundlewatch.io.svg">
</a>
<a href="https://github.com/bundlewatch/bundlewatch.io/blob/master/LICENSE">
<img src="https://img.shields.io/npm/l/bundlewatch.svg">
</a>

<h1>BundleWatch</h1>
<p>
BundleWatch checks file sizes, ensuring bundled browser assets don't jump in file size. <br />
Sharp increases in BundleWatch can signal that something is wrong - adding a package that bloats the slug, a wrong import, or forgetting to minify.
</p>
</div>

## This repo is the bundlewatch.io website
The BundleWatch CLI app and Node API is at https://github.com/bundlewatch/bundlewatch
Keep watch of your bundle size.

The BundleWatch service is at https://github.com/bundlewatch/service
[![GitHub License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/bundlewatch/bundlewatch.io/blob/master/LICENSE)

</div>

## Contributors
<hr />

BundleWatch checks file sizes, ensuring bundled browser assets don't jump in file size.

Thanks goes to these wonderful people ([emoji key][emojis]):
Sharp increases in BundleWatch can signal that something is wrong, such as adding a package that bloats the slug, an incorrect import, or forgetting to minify.

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="https://jakebolam.com"><img src="https://avatars2.githubusercontent.com/u/3534236?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jake Bolam</b></sub></a><br /><a href="https://github.com/bundlewatch/bundlewatch.io/commits?author=jakebolam" title="Code">💻</a></td>
<td align="center"><a href="https://opensource.tophat.com"><img src="https://avatars0.githubusercontent.com/u/6020693?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Shouvik DCosta</b></sub></a><br /><a href="https://github.com/bundlewatch/bundlewatch.io/commits?author=sdcosta" title="Code">💻</a></td>
<td align="center"><a href="http://www.tylerbenning.com"><img src="https://avatars2.githubusercontent.com/u/7265547?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tyler Benning</b></sub></a><br /><a href="#design-tbenning" title="Design">🎨</a></td>
<td align="center"><a href="http://www.6ixsushi.com"><img src="https://avatars3.githubusercontent.com/u/20323414?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Leila Rosenthal</b></sub></a><br /><a href="https://github.com/bundlewatch/bundlewatch.io/commits?author=leilarosenthal" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/francoiscampbell"><img src="https://avatars3.githubusercontent.com/u/3876970?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Francois Campbell</b></sub></a><br /><a href="https://github.com/bundlewatch/bundlewatch.io/commits?author=francoiscampbell" title="Code">💻</a></td>
<td align="center"><a href="http://consultlowtide.ca"><img src="https://avatars1.githubusercontent.com/u/13721239?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Martin Laws</b></sub></a><br /><a href="https://github.com/bundlewatch/bundlewatch.io/commits?author=martinlaws" title="Documentation">📖</a></td>
<td align="center"><a href="https://charpeni.com"><img src="https://avatars.githubusercontent.com/u/7189823?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nicolas Charpentier</b></sub></a><br /><a href="https://github.com/bundlewatch/bundlewatch.io/commits?author=charpeni" title="Code">💻</a> <a href="#maintenance-charpeni" title="Maintenance">🚧</a> <a href="#security-charpeni" title="Security">🛡️</a></td>
</tr>
</table>
## BundleWatch.io

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
> [!NOTE]
> This repo is the BundleWatch Service, for storing and computing BundleWatch data.
>
> The BundleWatch CLI app and Node API is at https://github.com/bundlewatch/bundlewatch.
>
> The BundleWatch.io documentation site is at https://github.com/bundlewatch/bundlewatch.io.

<!-- ALL-CONTRIBUTORS-LIST:END -->
## Contributors

<a href="https://github.com/bundlewatch/bundlewatch/graphs/contributors">
<img src="https://contrib.rocks/image?repo=bundlewatch/bundlewatch.io" />
</a>

## Want to Help? Become a Contributor
Contributions of any kind are welcome! [Join us on Slack](https://join.slack.com/t/bundlewatch/shared_invite/enQtMzUwNjYxNTMwMzcyLWE5NGI4MzZjMjM4MTRlYzllOTMwYzIzZWNjM2MyMjBmMzNjNGM0ZGVhODc2YjFkNzIwMzNkYjk3NzE0MjZkOTc) and start contributing.

Contributions of any kind are welcome!

Documentation powered by [docsifyJS](https://docsify.js.org/)

[bundlewatch]: https://img.shields.io/badge/bundle-watched-blue.svg
[bundlewatch-url]: https://bundlewatch.io

[emojis]: https://github.com/kentcdodds/all-contributors#emoji-key