Skip to content

docs: update README and API documentation for clarity and accuracy - #10

Merged
ronibhakta1 merged 1 commit into
readium:mainfrom
ronibhakta1:refactor/#9
Jul 3, 2026
Merged

docs: update README and API documentation for clarity and accuracy#10
ronibhakta1 merged 1 commit into
readium:mainfrom
ronibhakta1:refactor/#9

Conversation

@ronibhakta1

Copy link
Copy Markdown
Contributor

Closes #9
This pull request updates the README.md with clarifications and corrections regarding feature support, error handling, deployment details, and configuration options. The changes aim to provide a more accurate and comprehensive overview of the current state of the project, especially around word boundary support, error response formats, production deployment, and environment variables.

Feature Support and Status:

  • Clarified that word boundary data is not currently populated by any provider, and all voices report boundary: false (README.md) [1] [2].
  • Updated the provider status table to use "Planned" instead of "Coming soon" for Kokoro, ElevenLabs, and Azure Speech (README.md).

Deployment and Production Details:

  • Expanded production deployment instructions to specify nginx behavior, rate limiting, port usage, and restart policies for containers (README.md).

Error Handling:

  • Updated error response documentation to use RFC 9457 Problem Details format, and clarified which errors come from the app vs. nginx. Provided a more detailed error table and referenced a full API documentation file (README.md).

Configuration and Environment Variables:

  • Clarified that API key enforcement is reserved and not yet active, and documented new environment variables for provider selection and domain configuration (README.md).

@ronibhakta1
ronibhakta1 merged commit 116abdd into readium:main Jul 3, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

API doc refactor

1 participant