Skip to content

Commit

Permalink
docs: update usage
Browse files Browse the repository at this point in the history
  • Loading branch information
maddhruv committed May 3, 2021
1 parent 5ac1723 commit c94bf53
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
Keep your types in sync with DefinitelyTyped - auto install/uninstall types for dependencies on
postinstall.

[![npm version](https://badge.fury.io/js/types-sync.svg)](https://www.npmjs.com/package/types-sync)
[![CI](https://github.com/maddhruv/types-sync/actions/workflows/main.yml/badge.svg)](https://github.com/maddhruv/types-sync/actions/workflows/main.yml)

## Features

- Works with `npm`, `yarn`, `pnpm`, `bolt`
Expand All @@ -17,14 +20,16 @@ postinstall.

### As CLI

Use `types-sync` as `postinstall` or `prebuild` scripts in your _package.json_
Use `types-sync` as `prepare` or `prebuild` scripts in your _package.json_

```js
"scripts": {
"postinstall": "types-sync-types",
"prepare": "types-sync",
}
```

Note: use `types-sync` as the `prepare` script so that it only runs in the local environment.

### As Module

```ts
Expand Down

0 comments on commit c94bf53

Please sign in to comment.