@kerne/react 0.1.0 → 0.1.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Kerne
+Copyright (c) 2026 Kerne
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -0,0 +1,87 @@
+[![npm version](https://img.shields.io/npm/v/@kerne/react.svg)](https://www.npmjs.com/package/@kerne/react)
+[![npm downloads](https://img.shields.io/npm/dm/@kerne/react.svg)](https://www.npmjs.com/package/@kerne/react)
+[![npm license](https://img.shields.io/npm/l/@kerne/react.svg)](https://www.npmjs.com/package/@kerne/react)
+
+# @kerne/react
+
+Hooks and guard components for integrating Kerne authentication and entitlements into a React app. Never holds a secret key - only your public `appId`.
+
+## Installation
+
+```bash
+npm install @kerne/react
+```
+
+## Setup
+
+```tsx
+import { KerneProvider } from '@kerne/react';
+
+function App() {
+  return (
+    <KerneProvider appId={process.env.NEXT_PUBLIC_KERNE_APP_ID!}>
+      <YourApp />
+    </KerneProvider>
+  );
+}
+```
+
+## Authentication
+
+```tsx
+import { useAuth } from '@kerne/react';
+
+function LoginForm() {
+  const { login, isLoading } = useAuth();
+
+  return (
+    <button onClick={() => login({ email, password })}>
+      {isLoading ? 'Loading...' : 'Log in'}
+    </button>
+  );
+}
+```
+
+## Gating a feature
+
+`Allows` (and the underlying `useAccess` hook) check the logged-in user automatically - no scope to pass, the SDK already knows who's authenticated.
+
+```tsx
+import { Allows } from '@kerne/react';
+
+function ExportButton() {
+  return (
+    <Allows featureKey="export_pdf" fallback={<UpgradePrompt />}>
+      <button onClick={exportPdf}>Export as PDF</button>
+    </Allows>
+  );
+}
+```
+
+For the full detail behind a check (limit/used/remaining, not just a boolean), read `details` from the same hook - `const { allowed, details } = useAccess('api_calls')`.
+
+## Checkout & billing portal
+
+```tsx
+import { useCheckout, usePortal } from '@kerne/react';
+
+const { openCheckout } = useCheckout();
+const { openPortal } = usePortal();
+```
+
+## Core Hooks
+
+- `useAuth`: login, signup, logout, password reset, email verification, cross-origin session handoff (`redirectWithSession` - for an app hosting login on a different origin, e.g. a portal).
+- `useUser`: the current authenticated user's profile.
+- `useAccess`: feature access - `allowed` for the go/no-go, `details` for limit/used/remaining.
+- `useUsage`, `useEntitlements`: usage and full entitlement lists for the current user.
+- `useSubscription`, `usePlans`: the current subscription and the tenant's public plan catalog.
+- `useCheckout`, `usePortal`: hosted checkout and billing-portal sessions.
+
+## Documentation
+
+For full React SDK documentation and guides, visit [docs.kerne.io](https://docs.kerne.io/sdks/client/react).
+
+## License
+
+MIT