From ae59e1897e110431db2c7f1c1f734bc10d794e37 Mon Sep 17 00:00:00 2001 From: Sacha Servan-Schreiber <8027773+sachaservan@users.noreply.github.com> Date: Fri, 31 Oct 2025 15:58:27 -0400 Subject: [PATCH] chore: update readme --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9e7c8bf..6ec72bf 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ ![PyPI - Version](https://img.shields.io/pypi/v/tinfoil) [![Integration](https://github.com/tinfoilsh/tinfoil-python/actions/workflows/integration.yml/badge.svg)](https://github.com/tinfoilsh/tinfoil-python/actions/workflows/integration.yml) +[![Documentation](https://img.shields.io/badge/docs-tinfoil.sh-blue)](https://docs.tinfoil.sh/sdk/python-sdk) A Python client for secure AI model inference through Tinfoil. @@ -13,6 +14,8 @@ pip install tinfoil ## Usage +The Tinfoil SDK automatically selects a router enclave and verifies it against the official GitHub repository. You just need to provide your API key: + ```python import os from tinfoil import TinfoilAI @@ -67,7 +70,6 @@ client = AsyncTinfoilAI( ) async def main() -> None: - # start a streaming chat completion stream = await client.chat.completions.create( model="llama3-3-70b", messages=[{"role": "user", "content": "Say this is a test"}], @@ -128,11 +130,9 @@ Run unit and integration tests: pytest -q ``` -Integration tests require environment variables: +Integration tests require the `TINFOIL_API_KEY` environment variable: ```bash -export TINFOIL_ENCLAVE="..." -export TINFOIL_REPO="..." export TINFOIL_API_KEY="..." pytest -q -m integration ```