Skip to content

README: lead with what Database Agent does - #5

Merged
PradipNichite merged 1 commit into
mainfrom
docs/readme-product-first
Oct 23, 2026
Merged

PradipNichite merged 1 commit into
mainfrom
docs/readme-product-first

Conversation

@PradipNichite

Copy link
Copy Markdown
Contributor

Reorders the README introduction so it explains the product first, matching the structure decided for Document Intelligence.

  • Opening: what Database Agent does, who can use it, and how to start (live application, run locally, API).
  • New What you can do section: questions about your data, inspectable SQL and rows, charts, follow-up conversations, the free hosted sample-data demo, and the API and customisation.
  • The free demo is described as deployed: a synthetic e-commerce database (customers, products, orders, payments, returns), sign-in required, no own database or OpenAI key needed, 20 questions per rolling 24 hours and 100 in total per account.
  • Improved through real-world AI research follows, with links to the improvement history and the published benchmark results. The S64 example is unchanged.
  • Install, sample, guides, known limits, licence and provenance are unchanged.

Documentation only; no code changes.

🤖 Generated with Claude Code

Open with the product: plain-English questions over PostgreSQL or MySQL,
inspectable SQL and rows, charts, follow-up conversations, the free hosted
sample-data demo (20 per rolling 24 hours, 100 per account), self-hosting and
the API. The AI Demos research connection, the S64 example, the improvement
history and every technical section are kept, now after the product summary.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@PradipNichite
PradipNichite merged commit c723a44 into main Oct 23, 2026
4 checks passed
@PradipNichite
PradipNichite deleted the docs/readme-product-first branch October 23, 2026 12:08
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.

1 participant