Skip to content

Commit

Permalink
docs: update readme (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
G-Rath committed Apr 20, 2024
1 parent ecbbc9d commit 527e8ce
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ synchronizedPrettier.format("foo( )", { parser: "babel" });

This package is a simple wrapper of [`make-synchronized`](https://github.com/fisker/make-synchronized).

For more complex use cases, it more reasonable to extract functionality into a separate file, and run with [`make-synchronized`](https://github.com/fisker/make-synchronized), [`synckit`](https://github.com/un-ts/synckit), or [`make-synchronous`](https://github.com/sindresorhus/make-synchronous) etc.
For more complex use cases, it's better to use [`make-synchronized`](https://github.com/fisker/make-synchronized) directly:

Example:

Expand All @@ -53,6 +53,8 @@ export default makeSynchronized(import.meta, async function formatFile(file) {
});
```

Alternatively you can also use [`synckit`](https://github.com/un-ts/synckit) or [`make-synchronous`](https://github.com/sindresorhus/make-synchronous).

### `createSynchronizedPrettier(options)`

#### `options`
Expand Down

0 comments on commit 527e8ce

Please sign in to comment.