Merge pull request #16 from codemod/improve-readme-and-docs-organization

doc: Improve readme and docs organization

Author: alexbit-codemod

AUTO_PUBLISH_SETUP.md .github/AUTO_PUBLISH_SETUP.mdAUTO_PUBLISH_SETUP.md renamed to .github/AUTO_PUBLISH_SETUP.md

@@ -2,77 +2,25 @@
   <img src=".github/assets/migrations-template.png" alt="<ECOSYSTEM_NAME> Codemods" />
 </div>
 
-This repository serves as a template for open-source migrations, allowing contributors & framework maintainers to quickly whip up a repository for codemods that resolve breaking changes, refactors, and more.
+> **Remove this section once the repo is customized**
+> 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.
 
-This template repository comes pre-configured with a GitHub workflow that automatically publishes the latest version of your codemods, keeping them up-to-date on [Codemod Registry](https://app.codemod.com/registry).
+This repository contains codemods for <FRAMEWORK_OR_SDK_NAME>. These codemods facilitate adopting new features and upgrading across breaking changes.
 
-> **Initial setup guide (remove once the repo is customized)**
-> 
-> 1. Search and replace placeholders:
->    - `<ECOSYSTEM_NAME>` (e.g., "React", "Node.js", "AcmeLib")
->    - `@<NAMESPACE>` (e.g., `acme`) 
->    - `<MAJOR_VERSION>` (e.g., `v5`)
-> 2. Scaffold new codemods under `recipes` and name them like `@<NAMESPACE>/<MAJOR_VERSION> (optional)/<codemod-name>`:
-> 
-> ```bash
-> npx codemod@latest init recipes/my-codemod
-> ```
-> 
-> 3. Build codemod manually or with **[Codemod Studio](https://app.codemod.com/studio) (recommended)** ([Read docs →](https://go.codemod.com/studio-docs)).
-> 4. Validate and test:
-> 
-> ```bash
-> npm run validate
-> npm run test
-> ```
-> 
-> 5. Commit hooks and CI run lint, validate, typecheck, and tests.
-> 
-> 6. Set up auto-publishing to [Codemod Registry](https://app.codemod.com/registry):
-> 
->     1. **Get API key**: [https://app.codemod.com/api-keys](https://app.codemod.com/api-keys)
->     2. **Create GitHub Environment**: Repository Settings → Environments → New environment (name it `production`)
->     3. **Add secret**: `CODEMOD_API_KEY` with your API key
->     4. **Optional variables**: `CODEMOD_REGISTRY_SCOPE`, `CODEMOD_REGISTRY_URL`
-> 
-> This automatically publishes codemods when you merge changes to `main`. See [AUTO_PUBLISH_SETUP.md](./AUTO_PUBLISH_SETUP.md) for details.
 
+## Running codemods
+> [!CAUTION]
+> Codemods edit your code. Run them only on files tracked by Git, and make sure to commit or stash your changes first.
 
-## Overview
-
-This repository contains codemods (automated migrations) for <ECOSYSTEM_NAME>. These codemods facilitate adopting new features and upgrading across breaking changes.
-
-Codemods, public or private, are preferred to reside in repositories owned by the main organization of their respective projects. This repository serves as a template for codemod packages, allowing contributors to quickly create a repository for their published codemods.
-
-This template repository comes pre-configured with a GitHub workflow that automatically publishes the latest version of your codemod, eliminating the need to manually publish codemods after making updates.
-
-## Running Codemods
-
-To run your codemods use the codemod command below:
-
+Run codemods from the registry by using the names defined in their codemod.yaml:
 ```bash
-npx codemod@latest @<NAMESPACE>/<codemod-name>
+npx codemod@latest <codemod-name>
 ```
-
-- `codemod-name` - name of transform. Use the name of your codemod in Codemod Registry.
-
-See the [Codemod CLI documentation](https://go.codemod.com/cli-docs) for a full list of available commands and options.
-
-## Available Codemods
-
-> [!CAUTION]
-> These scripts change source code. Commit or stash your changes before running them.
-
-List your published codemods here, e.g.:
-- `@<NAMESPACE>/<MAJOR_VERSION>/example-codemod` — short description
-
-## Important
-
-After using this template, it's recommended that you update this README with:
-
-1. Details about what your codemod does (e.g. before/after code snippets)
-2. A link to the published codemod in Codemod Registry
-3. The accurate run command
+For example: 
+```
+npx codemod@latest @nodejs/tmpDir-to-tmpdir
+```
+See the [Codemod documentation](https://go.codemod.com/cli-docs) for a full list of available CLI commands and options.
 
 ## Contributing