Rewrite README for outsiders#39
Merged
Merged
Conversation
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>
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
Closes TIL-9 — the README is reframed for a stranger evaluating the project, per the ticket's acceptance criteria:
pip install tile-runtime(dist name vstileimport name stated explicitly, since baretileis taken on PyPI), then the embedding quickstart — the exact snippet proven in TIL-8's clean-venv packaging run.result=Schemaexample withmatchonCompleted/Failed, the per-promptcomplete/failmechanics, reserved names, and the schema design guidance — demand judgment not transcripts, bulk data onToolResult.details,summary: strfor guaranteed prose.outcomenon-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 (SDKmax_retries+ re-prompting).cwd, unboundBUILTIN_TOOLS, declare-cwd-to-receive-it custom tools.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 -iwith onlyOPENAI_API_KEY: the quickstart completed with correct tool-driven output, and the typed-results snippet returned a validatedWeatherReportthrough thematcharms as written.🤖 Generated with Claude Code