@better-i18n/next 0.2.1 → 0.2.2

package/README.md

@@ -1,11 +1,20 @@
 # @better-i18n/next
 
-Next.js integration for [Better i18n](https://better-i18n.com). Handles `next-intl` wiring, middleware, and CDN-based translation fetching.
+Next.js integration for [Better i18n](https://better-i18n.com). Provides seamless `next-intl` integration with CDN-powered translation fetching.
 
-## Install
+## Features
+
+- **Zero-Config Sync** - Connects to your project via `i18n.config.ts`
+- **Edge-Ready Caching** - Built-in ISR support for manifest and messages
+- **Type-Safe** - Full TypeScript support
+- **next-intl First** - Designed as a message provider for `next-intl`
+
+## Installation
 
 ```bash
-npm i @better-i18n/next next-intl
+npm install @better-i18n/next next-intl
+# or
+bun add @better-i18n/next next-intl
 ```
 
 ## Quick Start
@@ -13,21 +22,20 @@ npm i @better-i18n/next next-intl
 ### 1. Create i18n config
 
 ```ts
-// i18n.ts
+// i18n.config.ts
 import { createI18n } from "@better-i18n/next";
 
 export const i18n = createI18n({
-  project: "your-org/your-project",  // Format: "org-slug/project-slug"
+  project: "your-org/your-project", // Format: "org-slug/project-slug"
   defaultLocale: "en",
-  debug: process.env.NODE_ENV !== "production",
 });
 ```
 
 ### 2. Setup request config
 
 ```ts
-// app/i18n/request.ts
-import { i18n } from "./i18n";
+// src/i18n/request.ts
+import { i18n } from "../i18n.config";
 
 export default i18n.requestConfig;
 ```
@@ -36,15 +44,49 @@ export default i18n.requestConfig;
 
 ```ts
 // middleware.ts
-import { i18n } from "./i18n";
+import { i18n } from "./i18n.config";
 
 export default i18n.middleware;
 
 export const config = {
-  matcher: ["/", "/((?!api|_next|_vercel|.*\\..*).*)" ],
+  matcher: ["/((?!api|_next|.*\\..*).*)"],
 };
 ```
 
+### 4. Use translations
+
+```tsx
+// app/page.tsx
+import { useTranslations } from "next-intl";
+
+export default function Home() {
+  const t = useTranslations("common");
+  return <h1>{t("welcome")}</h1>;
+}
+```
+
+## Advanced Middleware
+
+For more control, use `createBetterI18nMiddleware`:
+
+```ts
+import { createBetterI18nMiddleware, composeMiddleware } from "@better-i18n/next/middleware";
+
+const i18nMiddleware = createBetterI18nMiddleware({
+  project: "org/project",
+  defaultLocale: "en",
+  detection: {
+    cookie: true,
+    browserLanguage: true,
+    cookieName: "locale",
+    cookieMaxAge: 31536000, // 1 year
+  },
+});
+
+// Compose with other middleware
+export default composeMiddleware(i18nMiddleware, authMiddleware);
+```
+
 ## Client Hook
 
 ```tsx
@@ -58,46 +100,61 @@ export function LanguageSwitcher() {
     defaultLocale: "en",
   });
 
-  if (error) throw error;
-  if (isLoading) return null;
+  if (isLoading) return <span>Loading...</span>;
+  if (error) return <span>Error: {error.message}</span>;
 
   return (
-    <ul>
+    <select>
       {languages.map((lang) => (
-        <li key={lang.code}>{lang.nativeName ?? lang.code}</li>
+        <option key={lang.code} value={lang.code}>
+          {lang.nativeName || lang.name || lang.code}
+        </option>
       ))}
-    </ul>
+    </select>
   );
 }
 ```
 
-## Server Helpers
+## Server Utilities
 
 ```ts
-import { getLocales, getMessages } from "@better-i18n/next/server";
+import {
+  getMessages,
+  getLocales,
+  getManifestLanguages,
+} from "@better-i18n/next/server";
 
-const config = { project: "your-org/your-project", defaultLocale: "en" };
+const config = { project: "org/project", defaultLocale: "en" };
 
 const locales = await getLocales(config);
 const messages = await getMessages(config, "tr");
+const languages = await getManifestLanguages(config);
 ```
 
 ## Configuration Options
 
-| Option | Type | Description |
-|--------|------|-------------|
-| `project` | `string` | **Required.** Format: `"org-slug/project-slug"` |
-| `defaultLocale` | `string` | **Required.** Default locale code (e.g., `"en"`) |
-| `cdnBaseUrl` | `string` | CDN URL (default: `https://cdn.better-i18n.com`) |
-| `debug` | `boolean` | Enable verbose logging |
-| `localePrefix` | `"as-needed" \| "always" \| "never"` | URL prefix strategy |
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `project` | `string` | required | Project identifier (`org/project` format) |
+| `defaultLocale` | `string` | required | Default/fallback locale code |
+| `cdnBaseUrl` | `string` | auto | CDN base URL (auto-detected) |
+| `localePrefix` | `"as-needed"` \| `"always"` \| `"never"` | `"as-needed"` | URL locale prefix behavior |
+| `manifestRevalidateSeconds` | `number` | `3600` | Next.js ISR revalidation for manifest |
+| `messagesRevalidateSeconds` | `number` | `30` | Next.js ISR revalidation for messages |
+| `debug` | `boolean` | `false` | Enable debug logging |
+| `logLevel` | `LogLevel` | `"warn"` | Logging verbosity |
 
 ## Debug Logging
 
 Enable with environment variables:
+
 - `BETTER_I18N_DEBUG=1`
 - `BETTER_I18N_LOG_LEVEL=debug|info|warn|error|silent`
 
+## Documentation
+
+Full documentation available at [docs.better-i18n.com/next](https://docs.better-i18n.com/docs/next)
+
 ## License
 
 MIT © [Better i18n](https://better-i18n.com)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@better-i18n/next",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Better-i18n Next.js integration",
   "license": "MIT",
   "repository": {
@@ -57,7 +57,7 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@better-i18n/core": "0.1.2"
+    "@better-i18n/core": "0.1.3"
   },
   "peerDependencies": {
     "next": ">=15.0.0",
@@ -68,7 +68,6 @@
   "devDependencies": {
     "next": "^15.4.4",
     "next-intl": "^4.5.8",
-    "@better-i18n/typescript-config": "0.0.0",
     "@types/node": "^20.0.0",
     "@types/react": "^19.0.0",
     "typescript": "~5.9.2"