Skip to content

Commit 4c9e803

Browse files
Fix typos and improve clarity in README.md
1 parent d26dbe2 commit 4c9e803

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
1-
> **Remove this section once the repo is customized**
1+
> **REMOEV THIS SECTION ONCE THE REPO IS SET UP.**
22
>
33
> 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.
44
> ## One-time Setup
55
>
66
> ### Secure a scope for your org
77
> 1. Sign up at [app.codemod.com](https://app.codemod.com) with your GitHub account.
88
> 2. Install the Codemod app:
9-
> - Go to [app.codemod.com/studio](https://app.codemod.com/studio)
10-
> - In **Results**, click **Select Repo**
11-
> - Installing the app for a repo in your GitHub org reserves a **scope** matching your org name.
9+
> 1. Go to [app.codemod.com/studio](https://app.codemod.com/studio)
10+
> 2. In **Results**, click **Select Repo**
11+
> 3. Installing the app for a repo in your GitHub org reserves a **scope** matching your org name.
1212
> - Example: only admins of the `nodejs` org can publish codemods starting with `@nodejs`.
1313
> - All official codemods appear in the Registry under that scope.
14-
> - **Important:** In each `codemod.yaml`, make sure `name` starts with your scope.
14+
> - **Important:** In each `codemod.yaml`, make sure `name` starts with your scope.
1515
>
1616
> ### Authorize GitHub Action
1717
> 1. Generate an API key at [app.codemod.com/api-keys](https://app.codemod.com/api-keys).
1818
> 2. In your repo: **Settings → Environments**
19-
> - Create an environment (e.g. `production`) if it doesn’t exist.
20-
> - Open it → **Add environment secret**:
21-
> - Name: `CODEMOD_API_KEY`
22-
> - Value: the key from step 1.
19+
> 1. Create an environment (e.g. `production`) if it doesn’t exist.
20+
> 3. Open it → **Add environment secret**:
21+
> - Name: `CODEMOD_API_KEY`
22+
> - Value: the key from step 1.
2323
>
2424
> ✅ Done! Now, after a codemod PR is merged, you can trigger a GitHub Action to auto-publish it to the [Codemod Registry](https://app.codemod.com/registry) under your org scope. See [Node.js codemods](https://codemod.link/nodejs-official) for an example.
2525
---

0 commit comments

Comments
 (0)