diff --git a/README.md b/README.md index 6d9964c..33dade9 100644 --- a/README.md +++ b/README.md @@ -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"; @@ -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