Update readme and docs

Author: ejsmith

docs/.vitepress/config.mts

@@ -7,12 +7,15 @@ export default defineConfig({
   base: "/",
   ignoreDeadLinks: true,
   head: [
-    ["link", {
-      rel: "icon",
-      href:
-        "https://raw.githubusercontent.com/FoundatioFx/Foundatio/main/media/foundatio-icon.png",
-      type: "image/png",
-    }],
+    [
+      "link",
+      {
+        rel: "icon",
+        href:
+          "https://raw.githubusercontent.com/FoundatioFx/Foundatio/main/media/foundatio-icon.png",
+        type: "image/png",
+      },
+    ],
     ["meta", { name: "theme-color", content: "#3c8772" }],
   ],
   themeConfig: {
@@ -25,6 +28,7 @@ export default defineConfig({
     siteTitle: "FetchClient",
     nav: [
       { text: "Guide", link: "/guide/what-is-fetchclient" },
+      { text: "API", link: "https://jsr.io/@foundatiofx/fetchclient/doc" },
       { text: "GitHub", link: "https://github.com/FoundatioFx/FetchClient" },
     ],
     sidebar: {
@@ -38,6 +42,8 @@ export default defineConfig({
             },
             { text: "Getting Started", link: "/guide/getting-started" },
             { text: "Features", link: "/guide/features" },
+            { text: "Usage Examples", link: "/guide/usage-examples" },
+            { text: "Contributing", link: "/guide/contributing" },
           ],
         },
       ],

docs/.vitepress/config.ts

@@ -0,0 +1,26 @@
+# Contributing
+
+## Development
+
+- Run tests: `deno test --allow-net`
+- Lint: `deno lint`
+- Format: `deno fmt`
+- Type check: `deno check scripts/*.ts *.ts src/*.ts`
+- Build npm package: `deno run -A scripts/build.ts`
+
+## Docs
+
+See `docs/`:
+
+- Dev: `npm run dev`
+- Build: `npm run build`
+- Preview: `npm run preview`
+
+## Links
+
+- API Reference: <https://jsr.io/@foundatiofx/fetchclient/doc>
+- Tests: `src/FetchClient.test.ts`
+
+## License
+
+MIT © Foundatio

docs/guide/contributing.md

@@ -0,0 +1,154 @@
+# Usage Examples
+
+This page consolidates common examples from the README.
+
+## Model Validator
+
+```ts
+import {
+  FetchClient,
+  ProblemDetails,
+  setModelValidator,
+} from "@foundatiofx/fetchclient";
+
+setModelValidator(async (data: object | null) => {
+  // use zod or any other validator
+  const problem = new ProblemDetails();
+  const d = data as { password: string };
+  if (d?.password?.length < 6) {
+    problem.errors.password = [
+      "Password must be longer than or equal to 6 characters.",
+    ];
+  }
+  return problem;
+});
+
+const client = new FetchClient();
+const data = { email: "test@test", password: "test" };
+
+const response = await client.postJSON(
+  "https://jsonplaceholder.typicode.com/todos/1",
+  data,
+);
+
+if (!response.ok) {
+  console.log(response.problem.detail);
+}
+```
+
+## Caching
+
+```ts
+import { FetchClient } from "@foundatiofx/fetchclient";
+
+type Todo = { userId: number; id: number; title: string; completed: boolean };
+
+const client = new FetchClient();
+const response = await client.getJSON<Todo>(
+  `https://jsonplaceholder.typicode.com/todos/1`,
+  {
+    cacheKey: ["todos", "1"],
+    cacheDuration: 1000 * 60, // 1 minute
+  },
+);
+
+// Invalidate programmatically
+client.cache.delete(["todos", "1"]);
+```
+
+## Rate Limiting
+
+```ts
+import { FetchClient, useRateLimit } from "@foundatiofx/fetchclient";
+
+useRateLimit({ maxRequests: 100, windowSeconds: 60 });
+
+const client = new FetchClient();
+await client.getJSON(`https://api.example.com/data`);
+```
+
+## Request Timeout & Cancellation
+
+```ts
+import { FetchClient } from "@foundatiofx/fetchclient";
+
+const client = new FetchClient();
+
+// Timeout per request
+await client.getJSON(`https://api.example.com/data`, { timeout: 5000 });
+
+// AbortSignal
+const controller = new AbortController();
+setTimeout(() => controller.abort(), 1000);
+
+await client.getJSON(`https://api.example.com/data`, {
+  signal: controller.signal,
+});
+```
+
+## Error Handling
+
+```ts
+import { FetchClient } from "@foundatiofx/fetchclient";
+
+const client = new FetchClient();
+
+try {
+  await client.getJSON(`https://api.example.com/data`);
+} catch (error) {
+  if ((error as any).problem) {
+    console.log((error as any).problem.title);
+    console.log((error as any).problem.detail);
+  }
+}
+
+// Or handle specific status codes
+await client.getJSON(`https://api.example.com/data`, {
+  expectedStatusCodes: [404, 500],
+  errorCallback: (response) => {
+    if (response.status === 404) {
+      console.log("Resource not found");
+      return true; // Don't throw
+    }
+  },
+});
+```
+
+## Authentication
+
+```ts
+import { FetchClient, setAccessTokenFunc } from "@foundatiofx/fetchclient";
+
+setAccessTokenFunc(() => localStorage.getItem("token"));
+
+const client = new FetchClient();
+await client.getJSON(`https://api.example.com/data`);
+// Authorization: Bearer <token>
+```
+
+## Base URL
+
+```ts
+import { FetchClient, setBaseUrl } from "@foundatiofx/fetchclient";
+
+setBaseUrl("https://api.example.com");
+
+const client = new FetchClient();
+await client.getJSON(`/users/123`);
+// Requests to https://api.example.com/users/123
+```
+
+## Loading State
+
+```ts
+import { FetchClient } from "@foundatiofx/fetchclient";
+
+const client = new FetchClient();
+
+client.loading.on((isLoading) => {
+  console.log(`Loading: ${isLoading}`);
+});
+
+console.log(client.isLoading);
+console.log(client.requestCount);
+```