@kerne/react 0.1.1 → 0.1.3

package/README.md

@@ -1,3 +1,7 @@
+[![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`.
@@ -40,21 +44,21 @@ function LoginForm() {
 
 ## Gating a feature
 
-`Allows` (and the underlying `useAllows` hook) check the logged-in user automatically - no scope to pass, the SDK already knows who's authenticated.
+`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 key="export_pdf" fallback={<UpgradePrompt />}>
+    <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), use `useCheck` instead of `useAllows`.
+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
 
@@ -67,9 +71,9 @@ const { openPortal } = usePortal();
 
 ## Core Hooks
 
-- `useAuth`: login, signup, logout, password reset, email verification.
+- `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.
-- `useAllows` / `useCheck`: feature access, boolean or full detail.
+- `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.