Skip to content
This repository has been archived by the owner on Feb 16, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mohab-sameh authored Feb 15, 2024
1 parent 879bead commit a21aec5
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@

Codemod Registry is an open-source, single-stop repository for codemods and code automation recipes. Codemod Registry brings an ever-growing variety of helpful codemods all in one place.

Codemods available in Codemod Registry are automatically integrated into the [Codemod platform](https://docs.codemod.io/docs/intro) and all developers who have the Codemod CLI or IDE extension can then discover, share, and run those codemods with a single click.
Codemods available in Codemod Registry are automatically integrated into the [Codemod platform](https://docs.codemod.com) and all developers who have the Codemod CLI or IDE extension can then discover, share, and run those codemods with a single click.

Currently, the Codemod platform supports `jscodeshift`, `ts-morph`, and Uber's Piranha codemod engines. If you would like to see a specific codemod engine supported, please [leave us a feature request](https://feedback.codemod.io/feature-requests-and-bugs).
Currently, the Codemod platform supports `jscodeshift`, `ts-morph`, and Uber's Piranha codemod engines. If you would like to see a specific codemod engine supported, please [leave us a feature request](https://feedback.codemod.com/feature-requests-and-bugs).

If there is a codemod you would like to see available in Codemod Registry, please consider opening a PR to add the codemod. Learn [more about contributing here](#contributing).

## Why use Codemod Registry

Adding or using codemods in Codemod Registry allows for:

🔗 Automatic integration with the Codemod [CLI](https://docs.codemod.io/docs/cli/quickstart) and [VS Code extension](https://marketplace.visualstudio.com/items?itemName=Codemod.codemod-vscode-extension).
🔗 Automatic integration with the Codemod [CLI](https://docs.codemod.com/docs/cli/quickstart) and [VS Code extension](https://marketplace.visualstudio.com/items?itemName=Codemod.codemod-vscode-extension).

:octocat: Ensuring codemods are reviewed and improved by [a community of codemod experts](https://codemod.com/community).

Expand Down Expand Up @@ -59,18 +59,18 @@ All codemods in the registry are automatically distributed to the Codemod CLI an

To run any codemod in the registry, you can:

- [Run codemod using Codemod VS Code extension](https://docs.codemod.io/docs/vs-code-extension/advanced-usage#dry-running-codemods).
- [Run codemod using Codemod CLI](https://docs.codemod.io/docs/cli/quickstart).
- [Run codemod using Codemod VS Code extension](https://docs.codemod.com/docs/vs-code-extension/advanced-usage#dry-running-codemods).
- [Run codemod using Codemod CLI](https://docs.codemod.com/docs/cli/quickstart).

## Contributing

Codemod Registry is an open-source, community-first, and community-powered project made for developers, by developers.

If you would like to contribute to the Codemod Registry, please [follow our contribution guide](https://docs.codemod.io/docs/codemod-registry/importing-codemods). Please note that once you create a pull request, you will be asked to sign our Contributor License Agreement.
If you would like to contribute to the Codemod Registry, please [follow our contribution guide](https://docs.codemod.com/docs/codemod-registry/importing-codemods). Please note that once you create a pull request, you will be asked to sign our Contributor License Agreement.

If you are a codemod builder and/or interested in codemods, please [join our community](https://codemod.io/community)!
If you are a codemod builder and/or interested in codemods, please [join our community](https://codemod.com/community)!

If you are not a codemod developer, but you would like to have the community contribute on developing a codemod you’re interested in, then feel free to [request a codemod here](https://feedback.codemod.io/codemod-requests).
If you are not a codemod developer, but you would like to have the community contribute on developing a codemod you’re interested in, then feel free to [request a codemod here](https://feedback.codemod.com/codemod-requests).

## Contributors ✨

Expand All @@ -85,7 +85,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<td align="center" valign="top" width="14.28%"><a href="https://maxleiter.com/"><img src="https://avatars.githubusercontent.com/u/8675906?v=4?s=100" width="100px;" alt="Max Leiter"/><br /><sub><b>Max Leiter</b></sub></a><br /><a href="https://github.com/codemod-com/codemod-registry/commits?author=MaxLeiter" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://medium.com/@greg-pabian/"><img src="https://avatars.githubusercontent.com/u/35925521?v=4?s=100" width="100px;" alt="Greg Pabian"/><br /><sub><b>Greg Pabian</b></sub></a><br /><a href="https://github.com/codemod-com/codemod-registry/commits?author=grzpab" title="Code">💻</a> <a href="https://github.com/codemod-com/codemod-registry/issues?q=author%3Agrzpab" title="Bug reports">🐛</a> <a href="https://github.com/codemod-com/codemod-registry/commits?author=grzpab" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/DmytroHryshyn"><img src="https://avatars.githubusercontent.com/u/125881252?v=4?s=100" width="100px;" alt="DmytroHryshyn"/><br /><sub><b>DmytroHryshyn</b></sub></a><br /><a href="https://github.com/codemod-com/codemod-registry/commits?author=DmytroHryshyn" title="Code">💻</a> <a href="https://github.com/codemod-com/codemod-registry/issues?q=author%3ADmytroHryshyn" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://codemod.io/"><img src="https://avatars.githubusercontent.com/u/78109534?v=4?s=100" width="100px;" alt="Alex Bit"/><br /><sub><b>Alex Bit</b></sub></a><br /><a href="https://github.com/codemod-com/codemod-registry/commits?author=alexbit-codemod" title="Code">💻</a> <a href="https://github.com/codemod-com/codemod-registry/commits?author=alexbit-codemod" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://codemod.com/"><img src="https://avatars.githubusercontent.com/u/78109534?v=4?s=100" width="100px;" alt="Alex Bit"/><br /><sub><b>Alex Bit</b></sub></a><br /><a href="https://github.com/codemod-com/codemod-registry/commits?author=alexbit-codemod" title="Code">💻</a> <a href="https://github.com/codemod-com/codemod-registry/commits?author=alexbit-codemod" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/hbjORbj"><img src="https://avatars.githubusercontent.com/u/32841130?v=4?s=100" width="100px;" alt="Benny Joo"/><br /><sub><b>Benny Joo</b></sub></a><br /><a href="https://github.com/codemod-com/codemod-registry/commits?author=hbjORbj" title="Code">💻</a> <a href="https://github.com/codemod-com/codemod-registry/issues?q=author%3AhbjORbj" title="Bug reports">🐛</a> <a href="https://github.com/codemod-com/codemod-registry/commits?author=hbjORbj" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/mohab-sameh"><img src="https://avatars.githubusercontent.com/u/37941642?v=4?s=100" width="100px;" alt="Mohab Sameh"/><br /><sub><b>Mohab Sameh</b></sub></a><br /><a href="https://github.com/codemod-com/codemod-registry/commits?author=mohab-sameh" title="Code">💻</a> <a href="https://github.com/codemod-com/codemod-registry/commits?author=mohab-sameh" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://zergus.github.io/"><img src="https://avatars.githubusercontent.com/u/5468045?v=4?s=100" width="100px;" alt="Serhii Melnyk"/><br /><sub><b>Serhii Melnyk</b></sub></a><br /><a href="#ideas-Zergus" title="Ideas, Planning, & Feedback">🤔</a></td>
Expand Down

0 comments on commit a21aec5

Please sign in to comment.