Skip to content

docs(readme): quickstart that runs after a plain pip install - #79

Merged
cryxnet merged 1 commit into
mainfrom
docs/readme-quickstart-plain-install
Oct 25, 2026
Merged

cryxnet merged 1 commit into
mainfrom
docs/readme-quickstart-plain-install

Conversation

@cryxnet

@cryxnet cryxnet commented Oct 25, 2026

Copy link
Copy Markdown
Collaborator

The README's "Get started in 30 seconds" used ChromaProvider, SemanticCache, the ML guardrails and a local MCP server, so it failed after a plain pip install promptise.

  • The example now uses an @tool function and only an API key. Checked in a fresh venv on PyPI 1.10.1 with openai:gpt-5-mini.
  • Connecting a local MCP server follows as the next step, with its own snippet.
  • Memory, cache and ML guardrails are no longer part of the first example.

🤖 Generated with Claude Code

The 30-second example needed Chroma, the semantic cache, the ML guardrails
and a running MCP server, so it failed on 'pip install promptise'. It now
uses an @tool function and an API key only (checked on PyPI 1.10.1); the
MCP server example follows as the next step.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@cryxnet
cryxnet merged commit 8c2f12d into main Oct 25, 2026
38 checks passed
@cryxnet
cryxnet deleted the docs/readme-quickstart-plain-install branch October 25, 2026 12:39
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