Skip to content

Commit 0be5b3f

Browse files
committed
docs: update README.md
1 parent 9a66c28 commit 0be5b3f

File tree

2 files changed

+24
-4
lines changed

2 files changed

+24
-4
lines changed

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,28 @@
1-
# SFC To ES Modules
1+
# Vue SFC To ES Modules
22

33
> Compile Vue SFC File to ES Modules.
44
5-
## Project setup
5+
## ✨ Features
6+
7+
* 💪 Fully Typed
8+
* 🌳 TreeShakable & SideEffects Free, Check out [Bundle Phobia](https://bundlephobia.com/result?p=sfc2esm)
9+
* 📁 Virtual File System (Support Compile `.vue/.js` File).
10+
* 👬 Friendly Error Tips
11+
12+
## 💡 Inspiration
13+
14+
This project is heavily inspired by [Vue Sfc Playground](https://github.com/vuejs/vue-next/tree/master/packages/sfc-playground)
15+
16+
17+
## 📦 Installation
18+
19+
```bash
20+
yarn add sfc2esm -S
21+
or
22+
npm i sfc2esm -S
23+
```
24+
25+
## 💻 Development
626
```
727
yarn install
828
```
@@ -17,6 +37,6 @@ yarn dev
1737
yarn build
1838
```
1939

20-
## License
40+
## 📄 License
2141

2242
MIT [@xiaoluoboding](https://github.com/xiaoluoboding)

examples/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { compileModules } from '../src/index'
22

33
(async function () {
4-
const modules = await compileModules()
4+
const modules = await compileModules('App.vue')
55
console.log(`successfully compiled ${modules.length} modules.`)
66
console.log(modules)
77
})()

0 commit comments

Comments
 (0)