diff --git a/packages/pf-codemods/README.md b/packages/pf-codemods/README.md index 1f801f07..39cd1ddb 100644 --- a/packages/pf-codemods/README.md +++ b/packages/pf-codemods/README.md @@ -16,6 +16,12 @@ Requires Node.js >= 10. npx @patternfly/pf-codemods ./path-to-src ``` +Note: when updating from PatternFly 5 to 6, add the `--v6` flag. + +```sh +npx @patternfly/pf-codemods --v6 ./path-to-src +``` + Giving node more RAM can help for large codebases. ```sh @@ -37,6 +43,9 @@ Options: --exclude Run recommended rules EXCLUDING this comma-seperated list --fix Whether to run fixer --format What eslint report format to use (default: "stylish") + --no-cache Disables eslint caching + --v4 Run v3 to v4 codemods + --v6 Run v5 to v6 codemods -h, --help display help for command ```