Skip to content

Rewrite README for outsiders#39

Merged
muneebshahid merged 1 commit into
mainfrom
feature/til-9-readme
Jul 12, 2026
Merged

Rewrite README for outsiders#39
muneebshahid merged 1 commit into
mainfrom
feature/til-9-readme

Conversation

@muneebshahid

Copy link
Copy Markdown
Owner

What

Closes TIL-9 — the README is reframed for a stranger evaluating the project, per the ticket's acceptance criteria:

  • Positioning: leads with "runtime, not a framework" — caller-constructed dependencies, no plugins/global config/hidden defaults.
  • Install + quickstart: pip install tile-runtime (dist name vs tile import name stated explicitly, since bare tile is taken on PyPI), then the embedding quickstart — the exact snippet proven in TIL-8's clean-venv packaging run.
  • Caveats up front: 0.x stability disclaimer, OpenAI-only, Python 3.13+.
  • Typed results section (from TIL-18): result=Schema example with match on Completed/Failed, the per-prompt complete/fail mechanics, reserved names, and the schema design guidance — demand judgment not transcripts, bulk data on ToolResult.details, summary: str for guaranteed prose.
  • Status/outcome contract: the invariant (outcome non-None ⟺ status == "completed"), the six-row terminal-state table, failure recovery (history at last stable state, healing, session re-promptable), and the no-retries position (SDK max_retries + re-prompting).
  • Prompt-caching note (from TIL-20): reuse one result schema per session; typed/plain flips re-read the session history at full price.
  • New cwd surface from TIL-23 documented in the quickstart: required cwd, unbound BUILTIN_TOOLS, declare-cwd-to-receive-it custom tools.
  • CI badge retained; Security Posture kept verbatim; architecture tree updated (agent.py, prompt.py, result.py).

Verification

Both code snippets were executed against the live OpenAI API (gpt-5.4) from the TIL-8 clean venv using the built 0.1.0 wheel, under env -i with only OPENAI_API_KEY: the quickstart completed with correct tool-driven output, and the typed-results snippet returned a validated WeatherReport through the match arms as written.

🤖 Generated with Claude Code

Positions Tile as a runtime rather than a framework, adds install and
verified quickstart instructions, documents typed results with schema
design guidance, the status/outcome contract, failure recovery, and the
prompt-caching guidance for result schemas.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@muneebshahid muneebshahid merged commit ec09470 into main Jul 12, 2026
2 checks passed
@muneebshahid muneebshahid deleted the feature/til-9-readme branch July 12, 2026 09:59
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