Skip to content

Commit

Permalink
readme tweak
Browse files Browse the repository at this point in the history
  • Loading branch information
silverwind committed Aug 10, 2024
1 parent bd8e70f commit 65a14df
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ The module uses global `fetch` under the hood. In Node.js HTTP proxies from envi

## Config File

The config file is used to configure certain options of the module. It be placed as `updates.config.{js,ts,mjs,mts}` or `config/updates.config.{js,ts,mjs,mts}`, relative to `package.json`. For typescript to work in Node 22.6.0 and above, set `NODE_OPTIONS="--experimental-strip-types"` in your environment.
The config file is used to configure certain options of the module. It be placed as `updates.config.{js,ts,mjs,mts}` or `config/updates.config.{js,ts,mjs,mts}`, relative to `package.json` / `pyproject.toml` / `go.mod`.

For typescript to work in Node 22.6.0 and above, set `NODE_OPTIONS="--experimental-strip-types"` in your environment.

```ts
import type {Config} from "updates";
Expand All @@ -59,7 +61,7 @@ export default {
} satisfies Config;
```

### Config File Options
### Config Options

- `include` *Array[String|Regexp]*: Array of dependencies to include
- `exclude` *Array[String|Regexp]*: Array of dependencies to exclude
Expand Down

0 comments on commit 65a14df

Please sign in to comment.