docs(postgres): add README with usage examples and config reference

[nuthalapativarun]

PR Checklist

• Commit message follows guidelines (conventional commits: <type>(<scope>): <description>)

Bugs / Features

• Related issue(s) linked
• Tests for the changes have been added
• Docs have been added / updated
• Changesets have been added (pnpm changeset)

What is the current behavior?

@voltagent/postgres has no README, so users have no documentation for installing or configuring the PostgreSQLMemoryAdapter and PostgreSQLVectorAdapter.

What is the new behavior?

Adds a README covering installation, the memory adapter and vector adapter usage examples, their configuration options, and a pointer to the existing integration test docs.

Notes for reviewers

Mirrors the style/structure of the recently added @voltagent/server-core README (#1331).

---

Summary by cubic

Add a README for @voltagent/postgres with install steps and usage examples for PostgreSQLMemoryAdapter and PostgreSQLVectorAdapter. Includes their configuration options and a link to the integration test docs.

^{Written for commit 84c06a0. Summary will update on new commits.}

Summary by CodeRabbit

• Documentation
  • Added comprehensive README for @voltagent/postgres with installation instructions, usage examples, and configuration options for PostgreSQL-backed memory and vector storage adapters.

[changeset-bot]

🦋 Changeset detected

Latest commit: 84c06a0

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@voltagent/postgres	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ed64b757-d16b-4544-a02b-b9461627b4df

📥 Commits

Reviewing files that changed from the base of the PR and between 0c1a1a4 and 84c06a0.

📒 Files selected for processing (2)

• .changeset/postgres-readme.md
• packages/postgres/README.md

---

📝 Walkthrough

Walkthrough

Adds a complete README.md to the packages/postgres package documenting PostgreSQLMemoryAdapter and PostgreSQLVectorAdapter, covering installation, TypeScript usage examples, configuration option tables, integration test instructions, related documentation links, and an MIT license notice. A corresponding patch changeset entry is also added.

Changes

PostgreSQL Package Documentation

Layer / File(s)

Summary

PostgreSQL adapters README and changeset packages/postgres/README.md, .changeset/postgres-readme.md

Adds the full package README with branding, install commands, TypeScript usage examples, and configuration tables for PostgreSQLMemoryAdapter and PostgreSQLVectorAdapter (connection, pool sizing, table prefix, schema, vector dimensions, cache/batch sizes, retry/backoff, searchPath, debug). Includes integration test Docker guidance, links to VoltAgent/memory/RAG docs, and MIT license. Adds a patch changeset entry.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 Hippity-hop, a README appears,
With tables and badges to calm developer fears!
Two adapters—memory and vectors—now shine,
With pool sizes, schemas, and searchPath so fine.
From install to license, the docs are complete,
A PostgreSQL story, tidy and neat! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely summarizes the main change: adding a README with usage examples and configuration reference for the postgres package.
Description check	✅ Passed	The description covers all required sections with detailed information about current behavior, new behavior, and includes a changeset note and conventional commit confirmation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[cubic-dev-ai]

No issues found across 2 files

_{Re-trigger cubic}