Skip to content

Commit b87ea1a

Browse files
authored
Doc updates.
1 parent 398373a commit b87ea1a

1 file changed

Lines changed: 26 additions & 8 deletions

File tree

README.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,21 @@
66

77
# Microbundle
88

9-
A **zero-configuration** bundler for _tiny modules_, powered by [Rollup].
9+
The **zero-configuration** bundler for _tiny modules_, powered by [Rollup].
10+
11+
## ✨ Features:
1012

1113
- Bundles your library using nothing but a `package.json`
12-
- Supports multiple entry modules (`cli.js` + `index.js`, etc)
13-
- Creates multiple output formats for each entry (CommonJS, UMD & ESM)
14+
- Support for ESnext & async/await _(via [Bublé] & [Nodent])_
15+
- Supports multiple entry modules _(`cli.js` + `index.js`, etc)_
16+
- Creates multiple output formats for each entry _(<abbr title="CommonJS (node)">CJS</abbr>, <abbr title="Universal Module Definition">UMD</abbr> & <abbr title="ECMAScript Modules">ESM</abbr>)_
17+
- Built-in Uglify compression & gzipped bundle size tracking
1418

15-
## Installation
19+
## 🔧 Installation
1620

1721
`npm i -D microbundle`
1822

19-
... then add it as an npm script:
23+
... then add the scripts to your `package.json`:
2024

2125
```js
2226
{
@@ -27,8 +31,10 @@ A **zero-configuration** bundler for _tiny modules_, powered by [Rollup].
2731
}
2832
```
2933

30-
## Usage
3134

35+
## 📦 Usage
36+
37+
Microbundle includes two commands - `build` (the default) and `watch`. Neither require any options, but you can tailor things to suit your needs a bit if you like.
3238

3339
### `microbundle` / `microbundle build`
3440

@@ -37,8 +43,9 @@ By default, microbundle will infer the location of your source entry file
3743

3844
### `microbundle watch`
3945

40-
Watches source files and rebuilds on any change.
46+
Just like `microbundle build`, but watches your source files and rebuilds on any change.
4147

48+
### All CLI Options
4249

4350
```
4451
microbundle [entries..]
@@ -65,9 +72,20 @@ Options:
6572
strict" [default: false]
6673
```
6774

68-
## License
75+
76+
## 🛣 Roadmap
77+
78+
Here's what's coming up for Microbundle:
79+
80+
- [TypeScript support](https://github.com/developit/microbundle/issues/5)
81+
- [Flowtype support](https://github.com/developit/microbundle/issues/5#issuecomment-351075881)
82+
83+
84+
## 🥂 License
6985

7086
MIT
7187

7288

7389
[Rollup]: https://github.com/rollup/rollup
90+
[Bublé]: https://gitlab.com/Rich-Harris/buble
91+
[Nodent]: https://github.com/MatAtBread/nodent-compiler

0 commit comments

Comments
 (0)