swift-readme
Use when the user asks to write, rewrite, improve, or restyle a README.md for an app, package, library, CLI, internal tool, or repository based on real project context. Best for creating accurate, polished READMEs from source structure, manifests, docs, assets, and examples without inventing capabilities.
Works with
--- name: swift-readme description: Use when the user asks to write, rewrite, improve, or restyle a README.md for an app, package, library, CLI, internal tool, or repository based on real project context. Best for creating accurate, polished READMEs from source structure, manifests, docs, assets, and examples without inventing capabilities. license: MIT --- # Swift README For Codex This is the Codex adapter for the repository's shared README playbook. Keep this file thin. The reusable guidance lives in `../../core/`. ## Codex workflow 1. Identify the repo type before drafting: app, package, library, SDK, CLI, internal tool, template, or mixed. 2. Read the current `README.md` if it exists. 3. Inspect the real project context: manifests, entry points, source tree, tests, docs, assets, examples, and license files. 4. Verify claims against the codebase. Never invent features, setup steps, compatibility, screenshots, links, or translations. 5. Load the matching file from `../../core/`. 6. Draft or rewrite the README around the fastest path to reader understanding. 7. If multiple topics apply, load only the additional core files you need. ## Workflow decision tree ### 1) App or product README Read [../../core/apps.md](../../core/apps.md). Use for: - iOS, macOS, web, or desktop apps - user-facing products - repos where visual proof and feature positioning matter early ### 2) Package, library, framework, or SDK README Read [../../core/packages.md](../../core/packages.md). Use for: - Swift packages - developer libraries - frameworks, SDKs, plugins, and reusable modules ### 3) CLI, internal tool, automation, or utility README Read [../../core/tools.md](../../core/tools.md). Use for: - CLIs - build tools - generators - scripts - internal workflows and operational utilities ### 4) Visual placement or demo decisions Read [../../core/visual-assets.md](../../core/visual-assets.md) when: - the repo contains screenshots, videos, GIFs, sample output, or demos - the README would be clearer with visual proof - you need to recommend a missing asset without inventing it ### 5) Rewrite-heavy cleanup Read [../../core/rewrites.md](../../core/rewrites.md) when: - an existing README is bloated, stale, duplicated, or poorly ordered - the user wants a rewrite rather than a new draft - you need a cleanup checklist before editing ### 6) Multilingual or license-sensitive README work Read [../../core/special-cases.md](../../core/special-cases.md) when: - the user asks for translated README support - translated README files already exist - the user asks for a specific license section style - the repo has a license file that the README should reflect ### 7) Contributor guidance or attribution Read [../../core/contributors.md](../../core/contributors.md) when: - the user asks for a `Contributing` section - the user asks for a `Contributors` section - you need to decide whether contributor guidance should be included ## Codex-specific notes - Install this skill with `npx skills add <repo> --skill swift-readme`, or copy `skills/swift-readme/` into your Codex skills directory manually. - Trigger it with `$swift-readme` or by asking Codex to use the `swift-readme` skill. - Treat `../../core/` as the source of truth for README guidance. - Do not duplicate shared guidance in this adapter unless Codex-specific behavior requires it. ## Shared contract Follow the contract described in [../../core/OVERVIEW.md](../../core/OVERVIEW.md): - inspect real repo context first - identify the repo type - load only the relevant core guidance - avoid invented claims, assets, and links - recommend visuals only when justified - include contributor sections only when relevant and verified, using git-derived names and avatars when available
More Mobile skills
animation-vocabulary
emilkowalski/skills
Reverse-lookup glossary that turns a vague description of a web animation or motion effect into its exact term ("the bouncy thing when a popover opens" → Pop in; "the iOS rubber-band scroll" → Rubber-banding). Use when the user asks "what's it called when…", or describes a motion effect without knowing its name and wants the right word to prompt an AI or designer with. For naming an effect, not designing or building one.
xcode-project-setup
firebase/agent-skills
Safely modifies Xcode projects (.pbxproj) to add Swift Packages and link files. Use this skill whenever an iOS project needs dependencies installed (e.g. Firebase, Alamofire).
cross-border-ecommerce
nexscope-ai/ecommerce-skills
Cross-border e-commerce expansion advisor. Scores target markets on 8 weighted dimensions (market size, ecommerce penetration, competition, regulatory complexity, logistics infrastructure, payment ecosystem, cultural distance, IP protection), compares 5 fulfillment models with cost and transit data, provides country-by-country tax/duty compliance guides (EU VAT/IOSS, UK VAT, US sales tax, CA GST, AU GST, JP consumption tax), maps local payment preferences by market, and builds a phased expansion roadmap. No API key required.
