Skip to content

chore: update readme #1529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 14, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<p align="center">
<br />
<a href="https://codemod.com/registry/">Registry</a>
<a href="https://go.codemod.com/app">Platform</a>
·
<a href="https://codemod.com/community">Community</a>
·
Expand All @@ -26,9 +26,17 @@ We are making dream migrations a reality for all developers in the world, one fr

## Documentation

For details on how to use Codemod platform, check out our [documentation](https://go.codemod.com/docs).
For details on how to use Codemod, check out our [documentation](https://go.codemod.com/docs).

## Quickstart
## Codemod Platform

Codemod platform helps you plan, automate, orchestrate, and track code migrations in codebases of any size.

To get started, go to [Codemod platform](https://go.codemod.com/app).

## Codemod CLI

### Quickstart

To get started, you can install Codemod CLI:

Expand All @@ -38,23 +46,23 @@ npm i -g codemod

With Codemod CLI, you can:

### 1. Build codemods
#### 1. Build codemods

You can easily build codemods using AI by opening a local project, making changes in a file, and running the following command:
You can easily scaffold and start building codemods by running the following command:

```
codemod learn
codemod init
```

### 2. Publish codemods
#### 2. Publish codemods

You can publish a [compatible](https://go.codemod.com/package-structure) local codemod package to [Codemod Registry](https://codemod.com/registry) with:

```
codemod publish
```

### 3. Run codemods
#### 3. Run codemods

```
codemod [codemod name]
Expand Down
Loading