add doc example

README.md

@@ -2,6 +2,10 @@
 
 **Typed OpenAI Chat Completions in Rust**
 
+[tysm on crates.io](https://crates.io/crates/tysm)
+
+[tysm on docs.rs](https://docs.rs/tysm/latest/tysm/)
+
 ## Table of Contents
 - [tysm - Thank You So Much](#tysm---thank-you-so-much)
   - [Table of Contents](#table-of-contents)

src/lib.rs

@@ -36,12 +36,64 @@
 //!         .unwrap();
 //!
 //!     assert_eq!(name.first, "George");
+
 //!     assert_eq!(name.last, "Washington");
+
 //! }
+
 //! ```
+
 //!
+
 //! Alternative name: **T**yped **S**chema **M**agic.
 
+//!
+
+//! ```rust,no_run
+
+//! use tysm::ChatClient;
+
+//!
+
+//! // Create a client from a `OPENAI_API_KEY` environment variable
+
+//! let client = ChatClient::from_env("gpt-4o");
+
+//! // or pass in your API key explicitly
+
+//! let client = ChatClient::new("sk-1234567890", "gpt-4o");
+
+//!
+
+//! // Define your response struct
+
+//! #[derive(serde::Deserialize, Debug, schemars::JsonSchema)]
+
+//! struct CityName {
+
+//!     english: String,
+
+//!     local: String,
+
+//! }
+
+//!
+
+//! # tokio_test::block_on(async {
+
+//! // Send a chat message to the API and deserialize the response into your struct
+
+//! let response: CityName = client.chat("What is the capital of Portugal?").await.unwrap();
+
+//!
+
+//! assert_eq!(response.english, "Lisbon");
+
+//! assert_eq!(response.local, "Lisboa");
+
+//! # })
+
+
 #![deny(missing_docs)]
 
 mod chatgpt;