Skip to content

Commit d258c58

Browse files
tilyupotilyupo
committed
chore: update readme
1 parent 7126d1d commit d258c58

5 files changed

Lines changed: 20 additions & 10 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Official JavaScript/TypeScript SDKs for [Replane](https://github.com/replane-dev
66
[![License](https://img.shields.io/github/license/replane-dev/replane-javascript)](https://github.com/replane-dev/replane-javascript/blob/main/LICENSE)
77
[![Community](https://img.shields.io/badge/discussions-join-blue?logo=github)](https://github.com/orgs/replane-dev/discussions)
88

9+
> **Tip:** Get started instantly with [Replane Cloud](https://cloud.replane.dev) — no infrastructure required.
10+
911
## Packages
1012

1113
| Package | Description | Links |
@@ -29,7 +31,7 @@ import { Replane } from "@replanejs/sdk";
2931
const replane = new Replane();
3032
await replane.connect({
3133
sdkKey: process.env.REPLANE_SDK_KEY!,
32-
baseUrl: "https://replane.example.com",
34+
baseUrl: "https://cloud.replane.dev", // or your self-hosted URL
3335
});
3436

3537
const featureEnabled = replane.get("my-feature");
@@ -48,7 +50,7 @@ function App() {
4850
return (
4951
<ReplaneProvider
5052
options={{
51-
baseUrl: "https://replane.example.com",
53+
baseUrl: "https://cloud.replane.dev", // or your self-hosted URL
5254
sdkKey: process.env.REPLANE_SDK_KEY!,
5355
}}
5456
>
@@ -116,7 +118,7 @@ npm install @replanejs/svelte
116118
117119
<ReplaneContext
118120
options={{
119-
baseUrl: "https://replane.example.com",
121+
baseUrl: "https://cloud.replane.dev", // or your self-hosted URL
120122
sdkKey: "your-sdk-key",
121123
}}
122124
>

‎packages/next/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
[![License](https://img.shields.io/github/license/replane-dev/replane-javascript)](https://github.com/replane-dev/replane-javascript/blob/main/LICENSE)
55
[![Community](https://img.shields.io/badge/discussions-join-blue?logo=github)](https://github.com/orgs/replane-dev/discussions)
66

7+
> **Tip:** Get started instantly with [Replane Cloud](https://cloud.replane.dev) — no infrastructure required.
8+
79
Next.js SDK for [Replane](https://github.com/replane-dev/replane) - feature flags and remote configuration with SSR support.
810

911
## Installation

‎packages/react/README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
[![License](https://img.shields.io/github/license/replane-dev/replane-javascript)](https://github.com/replane-dev/replane-javascript/blob/main/LICENSE)
55
[![Community](https://img.shields.io/badge/discussions-join-blue?logo=github)](https://github.com/orgs/replane-dev/discussions)
66

7+
> **Tip:** Get started instantly with [Replane Cloud](https://cloud.replane.dev) — no infrastructure required.
8+
79
React SDK for [Replane](https://github.com/replane-dev/replane) - feature flags and remote configuration.
810

911
## Installation
@@ -30,7 +32,7 @@ function App() {
3032
return (
3133
<ReplaneProvider
3234
connection={{
33-
baseUrl: "https://your-replane-server.com",
35+
baseUrl: "https://cloud.replane.dev", // or your self-hosted URL
3436
sdkKey: "your-sdk-key",
3537
}}
3638
loader={<div>Loading...</div>}
@@ -129,7 +131,7 @@ Integrates with React Suspense for loading states:
129131
<Suspense fallback={<LoadingSpinner />}>
130132
<ReplaneProvider
131133
connection={{
132-
baseUrl: "https://your-replane-server.com",
134+
baseUrl: "https://cloud.replane.dev", // or your self-hosted URL
133135
sdkKey: "your-sdk-key",
134136
}}
135137
suspense

‎packages/sdk/README.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
[![License](https://img.shields.io/github/license/replane-dev/replane-javascript)](https://github.com/replane-dev/replane-javascript/blob/main/LICENSE)
55
[![Community](https://img.shields.io/badge/discussions-join-blue?logo=github)](https://github.com/orgs/replane-dev/discussions)
66

7+
> **Tip:** Get started instantly with [Replane Cloud](https://cloud.replane.dev) — no infrastructure required.
8+
79
Small TypeScript client for watching configuration values from a Replane API with realtime updates and context-based override evaluation.
810

911
Part of the Replane project: [replane-dev/replane](https://github.com/replane-dev/replane).
@@ -61,7 +63,7 @@ const replane = new Replane<Configs>({
6163
// Connect to the server
6264
await replane.connect({
6365
sdkKey: process.env.REPLANE_SDK_KEY!,
64-
baseUrl: "https://replane.my-hosting.com",
66+
baseUrl: "https://cloud.replane.dev", // or your self-hosted URL
6567
});
6668

6769
// Get a config value (knows about latest updates via SSE)
@@ -158,7 +160,7 @@ interface Configs {
158160
const replane = new Replane<Configs>();
159161
await replane.connect({
160162
sdkKey: "your-sdk-key",
161-
baseUrl: "https://replane.my-host.com",
163+
baseUrl: "https://cloud.replane.dev", // or your self-hosted URL
162164
});
163165

164166
// Get value without context - TypeScript knows this is boolean
@@ -215,7 +217,7 @@ interface Configs {
215217
const replane = new Replane<Configs>();
216218
await replane.connect({
217219
sdkKey: "your-sdk-key",
218-
baseUrl: "https://replane.my-host.com",
220+
baseUrl: "https://cloud.replane.dev", // or your self-hosted URL
219221
});
220222

221223
// Subscribe to all config changes

‎packages/svelte/README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
[![License](https://img.shields.io/github/license/replane-dev/replane-javascript)](https://github.com/replane-dev/replane-javascript/blob/main/LICENSE)
55
[![Community](https://img.shields.io/badge/discussions-join-blue?logo=github)](https://github.com/orgs/replane-dev/discussions)
66

7+
> **Tip:** Get started instantly with [Replane Cloud](https://cloud.replane.dev) — no infrastructure required.
8+
79
Svelte SDK for [Replane](https://github.com/replane-dev/replane) - feature flags and remote configuration with reactive stores.
810

911
## Installation
@@ -21,7 +23,7 @@ npm install @replanejs/svelte
2123
2224
const replane = new Replane();
2325
await replane.connect({
24-
baseUrl: 'https://your-replane-server.com',
26+
baseUrl: 'https://cloud.replane.dev', // or your self-hosted URL
2527
sdkKey: 'your-sdk-key',
2628
});
2729
</script>
@@ -149,7 +151,7 @@ Can be used in several ways:
149151
150152
const replane = new Replane();
151153
await replane.connect({
152-
baseUrl: 'https://your-replane-server.com',
154+
baseUrl: 'https://cloud.replane.dev', // or your self-hosted URL
153155
sdkKey: 'your-sdk-key',
154156
});
155157
</script>

0 commit comments

Comments
 (0)