Skip to content

Commit db547f7

Browse files
authored
Refine README.md (#52)
1 parent 254ea33 commit db547f7

File tree

1 file changed

+20
-47
lines changed

1 file changed

+20
-47
lines changed

README.md

Lines changed: 20 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,39 @@
11
<div align="center">
22
<a href="http://bundlewatch.io">
3-
<img src="https://cdn.rawgit.com/bundlewatch/bundlewatch.io/master/docs/_assets/logo-large.svg" height="100px">
3+
<img src="https://cdn.rawgit.com/bundlewatch/bundlewatch.io/master/docs/_assets/logo-large.svg" width="600px">
44
</a>
55
<br>
6+
<br>
67

7-
[![bundlewatch][bundlewatch]][bundlewatch-url]
8-
[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors)
9-
<br>
10-
<a href="https://github.com/bundlewatch/bundlewatch.io/graphs/contributors">
11-
<img src="https://img.shields.io/github/contributors/bundlewatch/bundlewatch.io.svg">
12-
</a>
13-
<a href="https://github.com/bundlewatch/bundlewatch.io/blob/master/LICENSE">
14-
<img src="https://img.shields.io/npm/l/bundlewatch.svg">
15-
</a>
16-
17-
<h1>BundleWatch</h1>
18-
<p>
19-
BundleWatch checks file sizes, ensuring bundled browser assets don't jump in file size. <br />
20-
Sharp increases in BundleWatch can signal that something is wrong - adding a package that bloats the slug, a wrong import, or forgetting to minify.
21-
</p>
22-
</div>
23-
24-
## This repo is the bundlewatch.io website
25-
The BundleWatch CLI app and Node API is at https://github.com/bundlewatch/bundlewatch
8+
Keep watch of your bundle size.
269

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

12+
</div>
2913

30-
## Contributors
14+
<hr />
3115

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

33-
Thanks goes to these wonderful people ([emoji key][emojis]):
18+
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.
3419

35-
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
36-
<!-- prettier-ignore-start -->
37-
<!-- markdownlint-disable -->
38-
<table>
39-
<tr>
40-
<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>
41-
<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>
42-
<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>
43-
<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>
44-
<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>
45-
<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>
46-
<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>
47-
</tr>
48-
</table>
20+
## BundleWatch.io
4921

50-
<!-- markdownlint-restore -->
51-
<!-- prettier-ignore-end -->
22+
> [!NOTE]
23+
> This repo is the BundleWatch Service, for storing and computing BundleWatch data.
24+
>
25+
> The BundleWatch CLI app and Node API is at https://github.com/bundlewatch/bundlewatch.
26+
>
27+
> The BundleWatch.io documentation site is at https://github.com/bundlewatch/bundlewatch.io.
5228
53-
<!-- ALL-CONTRIBUTORS-LIST:END -->
29+
## Contributors
5430

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

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

37+
Contributions of any kind are welcome!
5938

6039
Documentation powered by [docsifyJS](https://docsify.js.org/)
61-
62-
[bundlewatch]: https://img.shields.io/badge/bundle-watched-blue.svg
63-
[bundlewatch-url]: https://bundlewatch.io
64-
65-
[emojis]: https://github.com/kentcdodds/all-contributors#emoji-key
66-

0 commit comments

Comments
 (0)