Improve README.md documentation structure and developer onboarding

[Copilot]

README needed better organization for discoverability and faster onboarding for new users.

Changes

• Quick Start section - Get running in under 2 minutes with minimal commands
• Table of Contents - Navigation for the comprehensive reference documentation
• Reorganized Features - Table format separating core capabilities from DX improvements
• Additional badges - License, TypeScript, Bun runtime indicators
• Troubleshooting section - Common issues (API key, command not found, model errors) with solutions
• Contributing section - PR workflow guidelines
• Streamlined Installation - Prerequisites upfront, clearer env var setup for Bash/Zsh/Fish
• Development section - Added lint/format commands

Structure

Quick Start → Features → Installation → Configuration → Usage → 
Multi-model → Error Handling → Development → Troubleshooting → 
API Docs → Pricing → Contributing → License → Support

All 63 tests pass. Documentation-only change.

Original prompt

Summary

Update the README.md to provide a clearer, more polished representation of the wavespeed-cli project, including:

Current State Assessment

• The project is a TypeScript CLI for Wavespeed AI's image generation and editing APIs
• Built with Bun (modern JavaScript runtime)
• TypeScript-based with comprehensive documentation
• Recently created (41 days old) and actively maintained
• Supports multiple commands: generate, edit, generate-sequential, edit-sequential

Proposed Improvements

1. Enhanced Project Overview

   • Add a more compelling project description
   • Include a clear statement of what the CLI is and why it exists
   • Add repository metadata (language, license, status)

2. Better Organization

   • Add a "Quick Start" section for faster onboarding
   • Reorganize sections for better flow and discoverability
   • Add a Table of Contents for easier navigation

3. Improved Badges and Metadata

   • Keep the CI/CD badge
   • Consider adding additional status indicators
   • Add relevant topic tags to highlight the project type

4. Clearer Feature Highlights

   • Better organize the features section
   • Highlight the unique multi-model support capability
   • Emphasize developer experience improvements (auto-download, base64 support)

5. Better Getting Started Experience

   • Streamline the installation instructions
   • Add prerequisites section upfront
   • Include environment variable setup examples
   • Add a minimal example that works immediately

6. Project Status and Roadmap

   • Add information about project maturity
   • Consider adding a roadmap or planned features section

7. Developer Experience

   • Keep comprehensive configuration documentation
   • Maintain detailed command reference
   • Keep advanced usage examples

8. Additional Sections

   • Add or enhance Contributing section reference
   • Add Troubleshooting section for common issues
   • Better organize Development section

The goal is to make the README more welcoming to new users while maintaining the comprehensive reference documentation for advanced users.

This pull request was created as a result of the following prompt from Copilot chat.

Summary

Update the README.md to provide a clearer, more polished representation of the wavespeed-cli project, including:

Current State Assessment

• The project is a TypeScript CLI for Wavespeed AI's image generation and editing APIs
• Built with Bun (modern JavaScript runtime)
• TypeScript-based with comprehensive documentation
• Recently created (41 days old) and actively maintained
• Supports multiple commands: generate, edit, generate-sequential, edit-sequential

Proposed Improvements

1. Enhanced Project Overview

   • Add a more compelling project description
   • Include a clear statement of what the CLI is and why it exists
   • Add repository metadata (language, license, status)

2. Better Organization

   • Add a "Quick Start" section for faster onboarding
   • Reorganize sections for better flow and discoverability
   • Add a Table of Contents for easier navigation

3. Improved Badges and Metadata

   • Keep the CI/CD badge
   • Consider adding additional status indicators
   • Add relevant topic tags to highlight the project type

4. Clearer Feature Highlights

   • Better organize the features section
   • Highlight the unique multi-model support capability
   • Emphasize developer experience improvements (auto-download, base64 support)

5. Better Getting Started Experience

   • Streamline the installation instructions
   • Add prerequisites section upfront
   • Include environment variable setup examples
   • Add a minimal example that works immediately

6. Project Status and Roadmap

   • Add information about project maturity
   • Consider adding a roadmap or planned features section

7. Developer Experience

   • Keep comprehensive configuration documentation
   • Maintain detailed command reference
   • Keep advanced usage examples

8. Additional Sections

   • Add or enhance Contributing section reference
   • Add Troubleshooting section for common issues
   • Better organize Development section

The goal is to make the README more welcoming to new users while maintaining the comprehensive reference documentation for advanced users.

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

---

Note

Overhauls README with Quick Start, improved installation/config and multi-model guidance, richer usage examples, troubleshooting, development/testing commands, contributing, and badges.

• Docs (README):
  • Add Quick Start and Table of Contents for faster onboarding.
  • Reorganize Features into Core capabilities and Developer Experience.
  • Improve Installation: prerequisites, corrected clone URL, build/link steps; API key setup for Bash/Zsh/Fish.
  • Expand Configuration: defaults, config file discovery, schema overview, env var interpolation; detail multi-model selection and add model listing flags (--list-models, --list-models-json).
  • Add comprehensive Usage examples for generate, edit, generate-sequential, edit-sequential, including common options and output behavior.
  • Document Error handling and exit codes; add Troubleshooting with common issues and fixes.
  • Enhance Development/Testing: include lint/format and test watch/coverage commands.
  • Add Contributing, clarify License, and add Support links.
  • Add badges for MIT license, TypeScript, and Bun runtime.

^{Written by Cursor Bugbot for commit 1723bd7. This will update automatically on new commits. Configure here.}

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

This pull request significantly improves the README.md documentation structure and organization to enhance developer onboarding and discoverability. The changes transform the README from a functional reference document into a comprehensive guide with progressive disclosure—starting with a Quick Start section for immediate usage, followed by detailed reference material.

Key Changes

• Added Quick Start section with streamlined 2-minute setup instructions
• Reorganized Features section into a table format separating Core Capabilities from Developer Experience
• Added Troubleshooting section with solutions for common issues (API key problems, command not found errors, model errors, and size format validation)
• Enhanced Prerequisites section with explicit Bun installation commands for different platforms
• Added Table of Contents for improved navigation
• Included additional badges (MIT License, TypeScript version, Bun runtime)

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The Table of Contents link text "Multi-model Selection" doesn't match the actual section heading "Multi-model selection" (capital vs lowercase 'S'). While the anchor link #multi-model-selection is correct, the inconsistent capitalization in the link text may confuse readers. Consider updating the TOC link text to match: [Multi-model selection](#multi-model-selection)

Suggested change

	- [Multi-model Selection](#multi-model-selection)
	- [Multi-model selection](#multi-model-selection)

[Copilot]

The Table of Contents is missing several sections that exist in the document: "API Documentation" (line 497), "Pricing" (line 506), and "Support" (line 527). These sections should be added to the TOC for better navigation and discoverability.

Suggested change

	- [Contributing](#contributing)
	- [Contributing](#contributing)
	- [API Documentation](#api-documentation)
	- [Pricing](#pricing)
	- [Support](#support)

[github-actions]

🎉 This PR is included in version 1.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀