Skip to content

Commit 58e02b9

Browse files
docs: make installatino of plugin more clear (hopefully)
Signed-off-by: David Dal Busco <david.dalbusco@outlook.com>
1 parent 9527789 commit 58e02b9

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

docs/setup-the-sdk.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,14 @@ If you intend to use Juno solely for **[hosting](./build/hosting/index.md)** pur
3131

3232
---
3333

34+
## TL;DR
35+
36+
1. Call `initSatellite()` in your app code
37+
2. Create a `juno.config` file at the root to define your Satellite
38+
3. Connect code and config — preferably using the `@junobuild/nextjs-plugin` or `@junobuild/vite-plugin`
39+
40+
---
41+
3442
## Initialization
3543

3644
1. Install the Juno SDK:
@@ -63,6 +71,10 @@ npx @junobuild/cli init --minimal
6371

6472
This creates a `juno.config` file — in TypeScript, JavaScript, or JSON depending on your preferences — at the root of your project. It contains metadata such as the Satellite ID used during SDK initialization.
6573

74+
---
75+
76+
## Connecting Code and Config
77+
6678
If you're using **Next.js** or **Vite**, we recommend installing the official plugin. It automatically loads values from your config file and injects them into your build as environment variables.
6779

6880
This means you can call `initSatellite()` without passing any parameters, the SDK will read them automatically from `process.env` or `import.meta.env`.

0 commit comments

Comments
 (0)