Skip to content

Commit 6d6deef

Browse files
Revise README for better guidance and organization
1 parent 8a43e3a commit 6d6deef

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,43 @@
1-
<div align="center">
2-
<img src=".github/assets/migrations-template.png" alt="<ECOSYSTEM_NAME> Codemods" />
3-
</div>
4-
51
> **Remove this section once the repo is customized**
6-
> Framework/SDK maintainers: This template comes with setup guides, utilities, and a GitHub Action to help you and your community build and publish codemods with ease. Once you, the repo maintainers, approve codemod PRs, they’ll be automatically published as official codemods to the [Codemod Registry](https://app.codemod.com/registry) under your org scope. Check out the [Node.js codemods](https://codemod.link/nodejs-official) for an example. See [AUTO_PUBLISH_SETUP.md](.github/AUTO_PUBLISH_SETUP.md) for setup instructions.
2+
>
3+
> Framework/SDK maintainers: This template comes with setup guides, utilities, and a GitHub Action to help you and your community build and publish codemods with ease. After the set up, once you approve codemod PRs, they’ll be automatically published as official codemods to the [Codemod Registry](https://app.codemod.com/registry) under your org scope. Check out the [Node.js codemods](https://codemod.link/nodejs-official) for an example. See [AUTO_PUBLISH_SETUP.md](.github/AUTO_PUBLISH_SETUP.md) for setup instructions.
4+
5+
Official <FRAMEWORK_OR_SDK_OR_ORG> codemods to help users adopt new features and handle breaking changes with ease.
76

8-
This repository contains codemods for <FRAMEWORK_OR_SDK_NAME>. These codemods facilitate adopting new features and upgrading across breaking changes.
7+
Community contributions are welcome and appreciated! Check open issues for codemods to build, or open a new one if something’s missing. See the [contribution guide](./CONTRIBUTING.md) for details.
98

109

1110
## Running codemods
1211
> [!CAUTION]
13-
> Codemods edit your code. Run them only on files tracked by Git, and make sure to commit or stash your changes first.
12+
> Caution: Codemods modify code! Run them only on Git-tracked files, and commit or stash changes first.
13+
### From the registry
14+
Recommended for better UX, downloads the package from [registry](https://app.codemod.com/registry).
1415

15-
Run codemods from the registry by using the names defined in their codemod.yaml:
1616
```bash
1717
npx codemod@latest <codemod-name>
1818
```
1919
For example:
2020
```
2121
npx codemod@latest @nodejs/tmpDir-to-tmpdir
2222
```
23-
See the [Codemod documentation](https://go.codemod.com/cli-docs) for a full list of available CLI commands and options.
23+
### From the source
24+
```bash
25+
npx codemod workflow run -w /path/to/folder/containing/workflow.yaml
26+
```
2427

25-
## Contributing
28+
> [!NOTE]
29+
> By default, codemods run in the current folder. Add `-t /target/path` to your command to change it.
30+
31+
32+
See the [Codemod docs](https://go.codemod.com/cli-docs) for all CLI commands and options.
2633

27-
See [CONTRIBUTING.md](./CONTRIBUTING.md).
2834

2935
## Security
3036

3137
See [SECURITY.md](./SECURITY.md).
3238

39+
3340
## License
3441

3542
MIT
3643

37-

0 commit comments

Comments
 (0)