@better-intl/react 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,89 @@
+# @better-intl/react
+
+React bindings for **better-intl** — Provider, hooks, `<T>` component.
+
+## Install
+
+```bash
+npm install @better-intl/react @better-intl/core
+```
+
+## Usage
+
+### Provider
+
+Wrap your app with `IntlProvider`:
+
+```tsx
+import { IntlProvider } from "@better-intl/react";
+import messages from "../locales/pt-BR.json";
+
+function App() {
+  return (
+    <IntlProvider locale="pt-BR" messages={messages}>
+      <MyApp />
+    </IntlProvider>
+  );
+}
+```
+
+### useTranslation hook
+
+```tsx
+import { useTranslation } from "@better-intl/react";
+
+function Greeting() {
+  const { t, locale } = useTranslation();
+
+  return (
+    <div>
+      <h1>{t("greeting", { name: "Alice" })}</h1>
+      <p>Current locale: {locale}</p>
+    </div>
+  );
+}
+```
+
+### `<T>` component
+
+For explicit marking of translatable text:
+
+```tsx
+import { T } from "@better-intl/react";
+
+function Hero() {
+  return (
+    <section>
+      <T>Hello world</T>
+      <T values={{ name: "Alice" }}>Hello {name}</T>
+    </section>
+  );
+}
+```
+
+### Interpolation
+
+Supports ICU-lite — variables, plurals, and select:
+
+```tsx
+const { t } = useTranslation();
+
+t("greeting", { name: "Alice" });       // "Hello Alice"
+t("items", { count: 3 });               // "3 items"
+t("pronoun", { gender: "female" });      // "She"
+```
+
+## API
+
+| Export | Description |
+|--------|-------------|
+| `IntlProvider` | Context provider — pass `locale` and `messages` |
+| `useTranslation()` | Returns `{ t, locale }` |
+| `useIntlContext()` | Returns the raw `IntlRuntime` |
+| `useTranslationRuntime(id, values?, default?)` | Low-level accessor used by compiler |
+| `T` | Explicit translation component |
+| `IntlContext` | React Context (for advanced use) |
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@better-intl/react",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "React bindings for better-intl — Provider, hooks, <T> component",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -14,10 +14,11 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "dependencies": {
-    "@better-intl/core": "0.1.0"
+    "@better-intl/core": "0.1.1"
   },
   "peerDependencies": {
     "react": "^19.0.0"