Documentation

ReadAware brings your books, annotations, conversations, and reading memory together in a local-first desktop app. Reading and organizing your library work without an AI account. Connect your own model provider, or an available ReadAware AI plan, when you want the assistant.

Start reading

• Download and install — choose a desktop package and understand updates.
• Getting started — import books, adjust the reader, use AI and web search, connect another assistant, and protect your data.

Build with ReadAware

Plugins can navigate books, work with annotations and memory, extend the assistant, and compose host services. Start with a task, then find the public contracts that support it.

• Plugin system — domains, contributions, services, and trust boundaries.
• Build a plugin — a small working plugin and the desktop development loop.
• Capabilities Explorer — search capabilities and API methods, inspect permissions, and copy manifest fragments.
• API reference — scopes, lifecycle, state changes, resources, background work, and composition.
• Publishing — package, review, and submit your plugin.

Documentation and app versions

These guides describe the current development build, including features that may arrive after the latest published app. Plugin reference pages follow the current development contract, and the latest published app can expose earlier capability versions. Check the Explorer and your installed app's ctx.capabilities; declare the versions your plugin actually needs in manifest.json.

Downloads and release notes are maintained on GitHub Releases. For support, use GitHub issues or Discord.