More docs

Author: ejsmith

docs/index.md

@@ -3,7 +3,7 @@ layout: home
 hero:
   name: Foundatio FetchClient
   text: Typed, ergonomic fetch for JS/TS
-  tagline: JSON helpers, caching, middleware, rate limiting, and great DX
+  tagline: JSON helpers, caching, middleware, rate limiting, circuit breaker, and great DX
   image:
     src: https://raw.githubusercontent.com/FoundatioFx/Foundatio/main/media/foundatio-icon.png
     alt: Foundatio
@@ -15,28 +15,114 @@ hero:
       text: View on GitHub
       link: https://github.com/FoundatioFx/FetchClient
 features:
-  - icon: ⚡
-    title: Typed Responses
-    details: Full TypeScript support for strongly-typed JSON results.
-  - icon: 🧩
-    title: Middleware & Caching
-    details: Compose middleware and cache responses with TTL.
-  - icon: 🎯
-    title: Rate Limits & Timeouts
-    details: Built-in rate limiting, timeouts, and robust error handling.
+  - icon: "\u26A1"
+    title: Typed JSON Helpers
+    details: getJSON, postJSON, putJSON, patchJSON, deleteJSON with full TypeScript support.
+  - icon: "\uD83C\uDFAF"
+    title: Two API Styles
+    details: Use simple functions or classes - your choice. Both have full access to all features.
+  - icon: "\uD83D\uDCBE"
+    title: Response Caching
+    details: TTL-based caching with cache keys and tags for grouped invalidation.
+  - icon: "\uD83E\uDDE9"
+    title: Middleware
+    details: Intercept requests and responses for logging, auth, transforms, and more.
+  - icon: "\uD83D\uDEA6"
+    title: Rate Limiting
+    details: Per-domain rate limits with automatic API header detection.
+  - icon: "\uD83D\uDEE1\uFE0F"
+    title: Circuit Breaker
+    details: Prevent cascading failures when services go down.
+  - icon: "\u23F1\uFE0F"
+    title: Timeouts & Cancellation
+    details: Request timeouts with native AbortSignal support.
+  - icon: "\uD83E\uDDEA"
+    title: Testing Built-in
+    details: MockRegistry for mocking HTTP requests without network calls.
 ---
 
 ## Quick Example
 
+FetchClient works two ways - pick whichever style you prefer:
+
+### Functional API
+
+```ts
+import { getJSON, postJSON, setBaseUrl } from "@foundatiofx/fetchclient";
+
+setBaseUrl("https://api.example.com");
+
+const { data: users } = await getJSON<User[]>("/users");
+const { data: created } = await postJSON<User>("/users", { name: "Alice" });
+```
+
+Or use `getFetchClient()` for fewer imports:
+
+```ts
+import { getFetchClient, setBaseUrl } from "@foundatiofx/fetchclient";
+
+setBaseUrl("https://api.example.com");
+
+const client = getFetchClient();
+const { data: users } = await client.getJSON<User[]>("/users");
+const { data: created } = await client.postJSON<User>("/users", { name: "Alice" });
+```
+
+### Class-Based API
+
 ```ts
 import { FetchClient } from "@foundatiofx/fetchclient";
 
-type Products = { products: Array<{ id: number; name: string }> };
+const client = new FetchClient({ baseUrl: "https://api.example.com" });
+const { data } = await client.getJSON<User[]>("/users");
+```
+
+## Caching
+
+```ts
+const { data } = await getJSON<User>("/api/users/1", {
+  cacheKey: ["users", "1"],
+  cacheDuration: 60000,
+  cacheTags: ["users"],
+});
+
+// Invalidate all user cache entries
+getCurrentProvider().cache.deleteByTag("users");
+```
+
+## Middleware
+
+```ts
+import { useMiddleware } from "@foundatiofx/fetchclient";
+
+useMiddleware(async (ctx, next) => {
+  console.log("Request:", ctx.request.url);
+  await next();
+  console.log("Response:", ctx.response?.status);
+});
+```
+
+## Rate Limiting & Circuit Breaker
+
+```ts
+import { usePerDomainRateLimit, useCircuitBreaker } from "@foundatiofx/fetchclient";
+
+// Prevent overwhelming APIs
+usePerDomainRateLimit({ maxRequests: 100, windowSeconds: 60 });
+
+// Stop requests when services fail
+useCircuitBreaker({ failureThreshold: 5, openDurationMs: 30000 });
+```
+
+## Testing
+
+```ts
+import { MockRegistry } from "@foundatiofx/fetchclient/mocks";
 
-const client = new FetchClient();
-const res = await client.getJSON<Products>(
-  `https://dummyjson.com/products/search?q=iphone&limit=10`,
-);
+const mocks = new MockRegistry();
+mocks.onGet("/api/users").reply(200, [{ id: 1, name: "Alice" }]);
+mocks.install(provider);
 
-console.log(res.data?.products.length);
+// Requests are mocked - no network calls
+const { data } = await getJSON("/api/users");
 ```