Skip to content

Commit 7126d1d

Browse files
committed
chore: update readme
1 parent 7ae1f87 commit 7126d1d

3 files changed

Lines changed: 18 additions & 16 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ Official JavaScript/TypeScript SDKs for [Replane](https://github.com/replane-dev
88

99
## Packages
1010

11-
| Package | Description | npm |
12-
| ---------------------------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
13-
| [`@replanejs/sdk`](./packages/sdk) | Core SDK for Node.js, Deno, Bun, and browsers | [![npm](https://img.shields.io/npm/v/@replanejs/sdk)](https://www.npmjs.com/package/@replanejs/sdk) |
14-
| [`@replanejs/react`](./packages/react) | React bindings with hooks and context | [![npm](https://img.shields.io/npm/v/@replanejs/react)](https://www.npmjs.com/package/@replanejs/react) |
15-
| [`@replanejs/next`](./packages/next) | Next.js SDK with SSR/SSG support | [![npm](https://img.shields.io/npm/v/@replanejs/next)](https://www.npmjs.com/package/@replanejs/next) |
16-
| [`@replanejs/svelte`](./packages/svelte) | Svelte bindings with stores | [![npm](https://img.shields.io/npm/v/@replanejs/svelte)](https://www.npmjs.com/package/@replanejs/svelte) |
11+
| Package | Description | Links |
12+
| ---------------------------------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13+
| [`@replanejs/sdk`](./packages/sdk) | Core SDK for Node.js, Deno, Bun, and browsers | [![npm](https://img.shields.io/npm/v/@replanejs/sdk)](https://www.npmjs.com/package/@replanejs/sdk) · [GitHub](https://github.com/replane-dev/replane-javascript/tree/main/packages/sdk#readme) |
14+
| [`@replanejs/react`](./packages/react) | React bindings with hooks and context | [![npm](https://img.shields.io/npm/v/@replanejs/react)](https://www.npmjs.com/package/@replanejs/react) · [GitHub](https://github.com/replane-dev/replane-javascript/tree/main/packages/react#readme) |
15+
| [`@replanejs/next`](./packages/next) | Next.js SDK with SSR/SSG support | [![npm](https://img.shields.io/npm/v/@replanejs/next)](https://www.npmjs.com/package/@replanejs/next) · [GitHub](https://github.com/replane-dev/replane-javascript/tree/main/packages/next#readme) |
16+
| [`@replanejs/svelte`](./packages/svelte) | Svelte bindings with stores | [![npm](https://img.shields.io/npm/v/@replanejs/svelte)](https://www.npmjs.com/package/@replanejs/svelte) · [GitHub](https://github.com/replane-dev/replane-javascript/tree/main/packages/svelte#readme) |
1717

1818
## Quick Start
1919

@@ -93,7 +93,7 @@ export default async function RootLayout({ children }: { children: React.ReactNo
9393
}
9494

9595
// app/page.tsx (client component)
96-
"use client";
96+
("use client");
9797
import { useConfig } from "@replanejs/next";
9898

9999
export default function Page() {

packages/sdk/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,10 @@ interface PasswordRequirements {
5151
// Create the client with optional constructor options
5252
const replane = new Replane<Configs>({
5353
context: {
54-
environment: "production",
54+
// example context
55+
userId: "user-123",
56+
plan: "premium",
57+
region: "us-east",
5558
},
5659
});
5760

@@ -77,9 +80,8 @@ const { minLength } = passwordReqs; // TypeScript knows this is PasswordRequirem
7780
// With context for override evaluation
7881
const enabled = replane.get("billing-enabled", {
7982
context: {
80-
userId: "user-123",
81-
plan: "premium",
82-
region: "us-east",
83+
plan: "free",
84+
deviceType: "mobile",
8385
},
8486
});
8587

packages/sdk/examples/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ Examples demonstrating how to use `@replanejs/sdk` across different JavaScript r
1515

1616
For React, Next.js, and Svelte applications, use the dedicated framework SDKs which provide hooks, context providers, and SSR support:
1717

18-
| Framework | Package | Examples |
19-
| ----------- | ------------------- | ----------------------------------------------------- |
20-
| **React** | `@replanejs/react` | [`packages/react/examples/`](../../react/examples/) |
21-
| **Next.js** | `@replanejs/next` | [`packages/next/examples/`](../../next/examples/) |
22-
| **Svelte** | `@replanejs/svelte` | [`packages/svelte/examples/`](../../svelte/examples/) |
18+
| Framework | Package | Examples | GitHub README |
19+
| ----------- | ------------------- | ----------------------------------------------------- | -------------------------------------------------------------------------------------------- |
20+
| **React** | `@replanejs/react` | [`packages/react/examples/`](../../react/examples/) | [README](https://github.com/replane-dev/replane-javascript/tree/main/packages/react#readme) |
21+
| **Next.js** | `@replanejs/next` | [`packages/next/examples/`](../../next/examples/) | [README](https://github.com/replane-dev/replane-javascript/tree/main/packages/next#readme) |
22+
| **Svelte** | `@replanejs/svelte` | [`packages/svelte/examples/`](../../svelte/examples/) | [README](https://github.com/replane-dev/replane-javascript/tree/main/packages/svelte#readme) |
2323

2424
## Quick Start
2525

0 commit comments

Comments
 (0)