Skip to content

Commit b17b9c7

Browse files
authored
[flags-sdk/openfeature] Fix dependencies and update README (#1115)
- Adds `pnpm` to the README - Adds `--legacy-peer-deps` to the `npm install` command `npm` fails to install due to the canary version being used. The `@vercel/analytics` requires Next.js >= 13, which it is, but `npm` does not recognise the canary tag. - Adds a step to install the Vercel CLI to the README
1 parent d12c9c6 commit b17b9c7

File tree

2 files changed

+157
-133
lines changed

2 files changed

+157
-133
lines changed

flags-sdk/openfeature/README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,19 @@ If you deployed your own instance of this example you can also use the [Flags Ex
2525

2626
### Step 1: Link the project
2727

28-
In order to use the Flags Explorer, you need to link the project on your local machine.
28+
First, install the latest version of the Vercel CLI:
29+
30+
```bash
31+
pnpm i -g vercel
32+
```
33+
34+
or
35+
36+
```bash
37+
npm i -g vercel
38+
```
39+
40+
To use the Flags Explorer, you need to connect your local project to your Vercel project:
2941

3042
```bash
3143
vercel link
@@ -44,11 +56,23 @@ vercel env pull
4456
### Step 3: Install dependencies
4557

4658
```bash
47-
npm install
59+
pnpm install
60+
```
61+
62+
or
63+
64+
```bash
65+
npm install --legacy-peer-deps
4866
```
4967

5068
### Step 4: Run the project
5169

70+
```bash
71+
pnpm run dev
72+
```
73+
74+
or
75+
5276
```bash
5377
npm run dev
5478
```

0 commit comments

Comments
 (0)