Skip to content

Commit 404f4dd

Browse files
mazzma12claude
andcommitted
update README with nvm-based dev setup instructions
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 4d561be commit 404f4dd

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,29 @@ The documentation is built using [Docusaurus](https://docusaurus.io/), a modern
88

99
## Pre-requisites
1010

11-
- Node.js (version 20 or later)
12-
- npm (Node package manager)
11+
- [nvm](https://github.com/nvm-sh/nvm) (Node Version Manager)
12+
- Node.js stable (install via nvm: `nvm install stable && nvm use stable`)
1313
- VSCode with recommended extensions installed (see `.vscode/extensions.json`)
1414

1515
## Installation
1616

1717
```console
18+
nvm use stable
19+
cd crowdsec-docs
1820
npm install
1921
```
2022

2123
## Local Development
2224

2325
```console
24-
npm run start
26+
nvm use stable
27+
cd crowdsec-docs
28+
npm start
29+
# or equivalently
30+
npx docusaurus start
2531
```
2632

27-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
33+
This command starts a local development server at http://localhost:3000. Most changes are reflected live without having to restart the server.
2834

2935
## Build
3036

0 commit comments

Comments
 (0)