# Localize README Files Safely

README translation often breaks links, badges, code examples, and anchors. This skill guides Claude, Codex, and Claude Code to create localized README variants while preserving repository mechanics.

## Install

```bash
npx skillstore add xixu-me/readme-i18n
```

## Metadata

- Status: approved
- Slug: xixu-me-readme-i18n
- Skillstore revision: r1
- Version status: missing
- Tree hash: e38800ec90878618dae733c5c40385c48e45f941a4a760d0e32e0f4efd0e3ff6
- Author: xixu-me
- GitHub username: xixu-me
- License: MIT
- Repository: https://github.com/xixu-me/skills/tree/main/skills/readme-i18n/
- Ref: 64ca8af0f54a325752f08bd54e52151061ea659a
- Supported tools: Claude, Codex, Claude Code
- Audit status: complete
- Agent install advisory: allowed
- Manual install advisory: allowed
- Artifact signature: available
- Audit attestation: unavailable
- Human verification: not\_verified
- Risk factors: external\_commands, env\_access
- Quality score: 75
- Public page: https://skillstore.pages.dev/skills/xixu-me-readme-i18n
- Manifest: https://skillstore.pages.dev/api/skills/xixu-me-readme-i18n/manifest

## Capabilities

- Creates localized README sibling files using repository naming conventions.
- Adds or updates one language selector across README variants.
- Preserves Markdown tables, code fences, badges, URLs, and file paths.
- Rewrites same-file anchor links after heading translation.
- Uses glossary and do-not-translate terms when provided.
- Reports created files, assumptions, and terms left unchanged.

## Use Cases

- Publish Multilingual README Files: Create translated README variants that keep badges, links, code examples, and headings aligned with the source file.
- Standardize Documentation Language Switchers: Add or update one language selector across README variants without duplicating selector blocks.
- Update Existing Localized Documentation: Refresh localized README files after source changes while preserving prior naming patterns and unchanged technical tokens.

## Prompt Templates

### Translate One README

```
Translate README.md into Spanish. Create README.es.md. Preserve code blocks, badge URLs, commands, and file paths.
```

### Add Language Selector

```
Create Chinese and Spanish README variants. Add one language selector near the top of each file.
```

### Extend Existing Variants

```
README.zh.md already exists. Add README.fr.md, update the selector in place, and keep existing naming conventions.
```

### Synchronize Changed Source

```
Compare README.md with existing localized README files. Update only changed prose, then verify anchors, selectors, and code fence counts.
```

## Limitations

- Focused on README files, not full application internationalization.
- Needs clear target languages or existing repository conventions.
- Does not validate translations with native speakers.
- Cannot guarantee links outside the repository remain available.

## Best Practices

- Provide target languages and any glossary before localization starts.
- Review translated headings and same-file anchors together.
- Keep product names, package names, commands, and environment variables unchanged.

## Anti Patterns

- Translating code fences, shell commands, URLs, or badge image sources.
- Adding a second language selector instead of updating the existing one.
- Changing section order without a repository reason.

## Security Audit

- Audited at: 2026-07-08T09:52:49.095\+00:00
- Summary: All static findings are false positives caused by Markdown examples, inline-code literals, and local README quality checks. No executable command path, environment access, network access, prompt injection, or malicious intent was found in the reviewed files.

## Stats

- Views: 89
- Downloads: 13
- Favorites: 1
- Popularity score: 0