|
1 | 1 | # BUNDLE BEE |
2 | 2 |
|
3 | | -Bundle Bee is an intuitive pgram that ingests your React project and instantiates an interactive analysis tool to help you compare your bundle composition, speed times and file sizes. Currently compatible with Webpack, Parcel and Rollup - our program will give you the needed configuration files to get started with whichever suits your needs. |
| 3 | +Bundle Bee is an intuitive program that ingests your React project and instantiates an interactive analysis tool to help you compare your bundle composition, speed times and file sizes. Currently compatible with Webpack, Parcel and Rollup - our program will give you the needed configuration files to get started with whichever suits your needs. |
4 | 4 |
|
5 | 5 | ### Getting Started: _Auto-config your webpack, parcel & rollup build tools._ |
6 | 6 |
|
7 | 7 | These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. |
8 | 8 |
|
9 | 9 | ### Prerequisites |
10 | | - |
11 | | -What things you need to install the software and how to install them |
12 | | - |
13 | | -``` |
14 | | -npm install -g bundle-bee |
15 | | -``` |
16 | | - |
17 | | -### Installing |
18 | | - |
19 | | - |
20 | | -A step by step series of examples that tell you how to get a development env running |
21 | | - |
22 | | -Say what the step will be |
23 | | - |
24 | | -``` |
25 | | -Give the example |
26 | | -``` |
27 | | - |
28 | | -And repeat |
29 | | - |
30 | | -``` |
31 | | -until finished |
32 | | -``` |
33 | | - |
34 | | -End with an example of getting some data out of the system or using it for a little demo |
35 | | - |
36 | | -## Running the tests |
37 | | - |
38 | | -Explain how to run the automated tests for this system |
39 | | - |
40 | | -### Break down into end to end tests |
41 | | - |
42 | | -Explain what these tests test and why |
43 | | - |
44 | | -``` |
45 | | -Give an example |
46 | | -``` |
47 | | - |
48 | | -### And coding style tests |
49 | | - |
50 | | -Explain what these tests test and why |
51 | | - |
52 | | -``` |
53 | | -Give an example |
54 | | -``` |
55 | | - |
56 | | -## Deployment |
57 | | - |
58 | | -Add additional notes about how to deploy this on a live system |
59 | | - |
60 | | -## Built With |
61 | | - |
62 | | -* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used |
63 | | -* [Maven](https://maven.apache.org/) - Dependency Management |
64 | | -* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds |
65 | | - |
66 | | -## Contributing |
67 | | - |
68 | | -Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us. |
69 | | - |
70 | | -## Versioning |
71 | | - |
72 | | -We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). |
73 | | - |
74 | | -## Authors |
75 | | - |
76 | | -* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth) |
77 | | - |
78 | | -See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project. |
79 | | - |
80 | | -## License |
81 | | - |
82 | | -This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details |
83 | | - |
84 | | -## Acknowledgments |
85 | | - |
86 | | -* Hat tip to anyone whose code was used |
87 | | -* Inspiration |
88 | | -* etc |
0 commit comments