Rewrite README to match the current architecture#21
Merged
Conversation
The old README described a stale API (save_concept_as_thoughtForm-style tools, 768-dim vectors, a Python sidecar doing embeddings/NER) that no longer matches src/server.ts. Rewrites the tool reference against the actual registered tools (save_concept, search_concepts, convert_concept, vault_* etc.), fixes the vector dimension to 384, documents real env-var config, Postgres/pgvector support, encrypted backups, and adds badges, Docker/k8s deployment notes, and a corrected clone URL.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What Changed
README.mdfrom scratch to match the current codebase instead of a stale earlier API surface.save_concept_as_thoughtForm,convert_concept_from_*, etc.) with the tools actually registered insrc/server.ts:save_concept,read_concept,delete_concept,list_concepts,batch_save_concepts,search_concepts,convert_concept,embed_text,health_check,get_stats,agentvault_backup, and the optionalvault_*tools.VECTOR_DIMENSION = 384,all-MiniLM-L6-v2).yourusername/politician→johnnyclem/polytician).POLYTICIAN_*variables insrc/config.ts), namespaces + optimistic concurrency (expectedVersion), the Postgres/pgvectorbackend, and AES-256-GCM encrypted PolyVault backups.Why
The previous README described an earlier API surface and was already flagged in its own text as "pending a rewrite" — several examples referenced tools, field names, and a 768-dim vector size that don't exist in the current implementation, which would actively mislead new users and integrators.
Validation
Risks / Rollback
Notes for Reviewers
README.md.Generated by Claude Code