docs (#3)

.github/workflows/ci.yml

@@ -29,5 +29,8 @@ jobs:
       - name: Run tests
         run: cargo test --verbose
 
+      - name: Build docs
+        run: cargo doc --no-deps
+
       - name: Check semver
         uses: obi1kenobi/cargo-semver-checks-action@v2

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "tysm"
-version = "0.2.9"
+version = "0.2.10"
 edition = "2021"
 description = "Typed OpenAI Chat Completions"
 license = "MIT"
@@ -19,7 +19,7 @@ serde_json = "1.0.107"
 thiserror = "2.0.9"
 tynm = "0.1.10"
 lru = "0.12.5"
-schemars = { git = "https://github.com/GREsau/schemars.git", version = "1.0.0-alpha.17", features = [
+schemars = { git = "https://github.com/GREsau/schemars.git", features = [
     "preserve_order",
 ] }
 

README.md

@@ -1,9 +1,9 @@
-# tysm
+# tysm - Thank You So Much
 
 **Typed OpenAI Chat Completions in Rust**
 
 ## Table of Contents
-- [tysm](#tysm)
+- [tysm - Thank You So Much](#tysm---thank-you-so-much)
   - [Table of Contents](#table-of-contents)
   - [Usage](#usage)
   - [Features](#features)

src/chatgpt.rs

@@ -245,6 +245,9 @@ impl ChatClient {
     /// It will also look in the `.env` file for an `OPENAI_API_KEY` variable (using dotenv).
     ///
     /// ```rust
+    /// # use tysm::ChatClient;
+    /// let client = ChatClient::from_env("gpt-4o").unwrap();
+    /// ```
     pub fn from_env(model: impl Into<String>) -> Result<Self, OpenAiApiKeyError> {
         Ok(Self::new(api_key()?, model))
     }

src/lib.rs

@@ -1,6 +1,46 @@
-//! A simple library to interact with the ChatGPT API.
+//! # `tysm` - Thank You So Much
 //!
-//! It uses the [schemars](https://docs.rs/schemars/latest/schemars/index.html) crate to generate a schema for the desired response type.
+//! Typed OpenAI Chat Completions.
+//!
+//! A strongly-typed Rust client for OpenAI's ChatGPT API that enforces type-safe responses using [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
+//!
+//! This library uses the [schemars](https://docs.rs/schemars/latest/schemars/index.html) crate to generate a schema for the desired response type. It also uses [serde](https://docs.rs/serde/latest/serde/index.html) to deserialize the response into the desired type. Install these crates like so:
+//!
+//! 1. `cargo add serde`.
+//! 2. `cargo add --git https://github.com/GREsau/schemars.git schemars`
+//!
+//! ## Usage
+//!
+//! ```rust,ignore
+//! use tysm::ChatClient;
+//!
+//! // We want names separated into `first` and `last`.
+//! #[derive(serde::Deserialize, schemars::JsonSchema)]
+//! struct Name {
+//!     first: String,
+//!     last: String,
+//! }
+//!
+//! async fn get_president_name() {
+//!     // Create a client.
+//!     // `from_env` will look for an API key under the environment
+//!     // variable "OPENAI_API_KEY"
+//!     // It will also look inside `.env` if such a file exists.
+//!     let client = ChatClient::from_env("gpt-4o").unwrap();
+//!     
+//!     // Request a chat completion from OpenAI and
+//!     // parse the response into our `Name` struct.
+//!     let name: Name = client
+//!         .chat("Who was the first US president?")
+//!         .await
+//!         .unwrap();
+//!
+//!     assert_eq!(name.first, "George");
+//!     assert_eq!(name.last, "Washington");
+//! }
+//! ```
+//!
+//! Alternative name: **T**yped **S**chema **M**agic.
 
 #![deny(missing_docs)]