Skip to content

Commit 58e6cfb

Browse files
committed
docs: update
1 parent c865ffa commit 58e6cfb

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,14 @@
33
[![Unit Test](https://github.com/unplugin/unplugin-quansync/actions/workflows/unit-test.yml/badge.svg)](https://github.com/unplugin/unplugin-quansync/actions/workflows/unit-test.yml)
44

55
Write async functions, get both async and sync functions with
6-
[quansync](https://github.com/antfu/quansync) and compiler magics.
6+
[quansync](https://github.com/antfu/quansync) and compile-time magics 🪄.
7+
8+
## Features
9+
10+
- 🪄 **Compile-time magic**: Write async functions, get both async and sync functions.
11+
- 🦾 **Type-safe**: Fully typed with TypeScript.
12+
- 🌱 **Lightweight**: No runtime dependencies.
13+
- 🚀 **Zero-config**: Works out of the box with Vite, Rollup, Webpack, esbuild, and more.
714

815
## Installation
916

@@ -99,6 +106,8 @@ export default {
99106

100107
## Usage
101108

109+
Here is an example:
110+
102111
```ts
103112
import fs from 'node:fs'
104113
import { quansyncMacro } from 'quansync'
@@ -124,8 +133,7 @@ const result = myFunction.sync('./some-file.js')
124133
const asyncResult = await myFunction.async('./some-file.js')
125134
```
126135

127-
For more details, please refer to the
128-
[quansync documentation](https://github.com/antfu/quansync#usage).
136+
For more details on usage, refer to [quansync's docs](https://github.com/antfu-collective/quansync#usage).
129137

130138
## Sponsors
131139

0 commit comments

Comments
 (0)