From d4e97ce2725c138a46e175edd701cdc286f6ff14 Mon Sep 17 00:00:00 2001 From: Jake Bolam Date: Sat, 28 Apr 2018 23:37:03 -0400 Subject: [PATCH 1/2] Update README.md (#12) * Update README.md * edited content --- README.md | 46 +++++++++++++++++++++++++--------------------- 1 file changed, 25 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 50b157e..95daee7 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,41 @@ -# bundlesize -[![CircleCI](https://circleci.com/gh/bundlesize/bundlesize.svg?style=svg)](https://circleci.com/gh/bundlesize/bundlesize) +

+ +

+ Keep your bundle size in check +
+

+ + [![npm version](https://badge.fury.io/js/%40bundlesize%2Fbundlesize.svg)](https://badge.fury.io/js/%40bundlesize%2Fbundlesize) + [![CircleCI](https://circleci.com/gh/bundlesize/bundlesize.svg?style=svg)](https://circleci.com/gh/bundlesize/bundlesize) + Inspired by the original [Siddharth Kshetrapal / Bundlesize](https://github.com/siddharthkp/bundlesize) -# In this fork of bundlesize we are aiming to: +# Getting Started and Configuration +Follow the documentation on the new site [bundlesize.io](http://bundlesize.io/) + + + +## Why the change in direction from the original? +- The original bundlesize has entered maintenance mode, pull requests are left hanging - Split store into seperate app -> bundlesize/service with infrastructure as code - Enough test coverage to support CD - Node API Support -- Lower the barier to contributing +- Lower the barrier to contributing, build a trusted community of contributors to have continous improvement - Lots lots more -## Want to help? Join us on slack and find out -[bundlesize-bundlesize on slack](https://join.slack.com/t/bundlesize-bundlesize/shared_invite/enQtMzUwNjYxNTMwMzcyLWE5NGI4MzZjMjM4MTRlYzllOTMwYzIzZWNjM2MyMjBmMzNjNGM0ZGVhODc2YjFkNzIwMzNkYjk3NzE0MjZkOTc) - - -This is a work in progress, watch this space -## TODO -- [x] Obtain parity with bundlesize (using Node API approach) -- [x] Support new features -- [x] Split store into service -- [ ] Docs on how to CONTRIBUTE/LOCAL SETUP etc -- [ ] Better tests - - -### Feature list: +### New features: - [x] Config validation to stop users guessing why bundlesize won't work -- [x] Update message -- [x] Support branches other than master -- [ ] Show history of bundlesizes over time +- [x] New and improved CI behaviour +- [x] Better comparisons between branches, support branches other than master +- [ ] Show history of bundlesizes over time (Coming soon) ### Enabling for CI: https://github.com/login/oauth/authorize?scope=repo%3Astatus&client_id=04fcf325dd26ca2a159f +## Want to help? +[Join us on Slack](https://join.slack.com/t/bundlesize-bundlesize/shared_invite/enQtMzUwNjYxNTMwMzcyLWE5NGI4MzZjMjM4MTRlYzllOTMwYzIzZWNjM2MyMjBmMzNjNGM0ZGVhODc2YjFkNzIwMzNkYjk3NzE0MjZkOTc) and start contributing + From a37681ff00da0c6c43e491a58e7a93de261ebc09 Mon Sep 17 00:00:00 2001 From: Jake Bolam Date: Sat, 28 Apr 2018 23:51:24 -0400 Subject: [PATCH 2/2] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 95daee7..ab343dc 100644 --- a/README.md +++ b/README.md @@ -12,17 +12,17 @@ Inspired by the original [Siddharth Kshetrapal / Bundlesize](https://github.com/siddharthkp/bundlesize) # Getting Started and Configuration -Follow the documentation on the new site [bundlesize.io](http://bundlesize.io/) +Follow the documentation on [bundlesize.io](http://bundlesize.io/) ## Why the change in direction from the original? -- The original bundlesize has entered maintenance mode, pull requests are left hanging +- The original bundlesize has entered maintenance mode, pull requests are left hanging, we wanted to reboost the community and start growing bundlesize out - Split store into seperate app -> bundlesize/service with infrastructure as code +- Launched documentation website - Enough test coverage to support CD - Node API Support - Lower the barrier to contributing, build a trusted community of contributors to have continous improvement -- Lots lots more ### New features: