diff --git a/README.md b/README.md index 52cad660c..5c2ef86f4 100644 --- a/README.md +++ b/README.md @@ -4,38 +4,6 @@ build-test status versions status proxy status

-## About this fork -This is a fork of the official GitHub [actions/setup-node](https://github.com/marketplace/actions/setup-node-js-environment) that checks common Node config files when picking the version of Node to use. - -### Example - -```yaml -- name: Setup node - uses: guardian/actions-setup-node@main -``` - -It checks the following places: - -1. `.nvmrc` -2. `engines.node` in `package.json` -3. `.node-version` -4. `.n-node-version` -5. `.naverc` -6. `.nodeenvrc` - -and finally the following environment variables: - -7. `NODE_VERSION` -8. `NODIST_NODE_VERSION` - -> Behind the scenes, it uses [@ehmicky](https://github.com/ehmicky)'s [`preferred-node-version`](https://www.npmjs.com/package/) 😍. - -If it _still_ can't find anything, it falls back to the the original action's default behaviour (using the PATH version). - -_Below is the rest of the original readme…_ - ---- - This action sets by node environment for use in actions by: - optionally downloading and caching a version of node - npm by version spec and add to PATH @@ -234,4 +202,4 @@ Contributions are welcome! See [Contributor's Guide](docs/contributors.md) ## Code of Conduct -:wave: Be nice. See [our code of conduct](CONDUCT) +:wave: Be nice. See [our code of conduct](CONDUCT) \ No newline at end of file