From 84e02465d43d309934cd685d59c31ab4df049e57 Mon Sep 17 00:00:00 2001 From: Bram Suurd <78373894+BramSuurdje@users.noreply.github.com> Date: Wed, 1 May 2024 22:52:22 +0200 Subject: [PATCH] update contribution instructions in readme --- README.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 33c51fe..470e94c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Unofficial re-design of the [Proxmox helper script website](https://tteck.github.io/Proxmox/) -feel free to fork the project. or post feedback in the [Discussion tab](https://github.com/BramSuurdje/proxmox-helper-scripts/discussions). your feedback is always welcomed since we're all learing. +feel free to fork the project. or post feedback in the [Discussion tab](https://github.com/BramSuurdje/proxmox-helper-scripts/discussions). your feedback is always welcomed since we're all learing. ## Todo @@ -11,4 +11,32 @@ feel free to fork the project. or post feedback in the [Discussion tab](https:// - [ ] Add modern landing page. - [ ] Add links for videos mentioning the script - [ ] Add links for socials. e.g. discord etc -- [ ] FIX: fix drop downs not opening when searching \ No newline at end of file +- [ ] FIX: fix drop downs not opening when searching + +## How to contribute + +First, install the dependencies: + +```bash +npm install +# or +yarn install +# or +pnpm install +# or +bun install +``` + +Then, run the development server: + +```bash +npm run dev +# or +yarn dev +# or +pnpm dev +# or +bun dev +``` + +Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.