From 87c2e63248ba15410915fc54bb7761f00e354f2c Mon Sep 17 00:00:00 2001 From: Aidan Date: Thu, 27 Mar 2025 15:11:28 -0400 Subject: [PATCH] docs: add clearer install instructions, instructions for bun, fix link, lint --- README.md | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6e5b634..0ed42cb 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,40 @@ # Giv's Website ## Introduction + Hey, this is my website! You will be able to know what I'm good on and how to contact me through there. -## Used Technologies +## Technology Stack + - React - TypeScript - Vite ## How to access? + - Thanks to NineTailed, the deploy is available [here](https://givfnz.com) - If you want to check the source code, visit the project repo on [Gitea](https://git.pontusmail.org/GivFNZ/my-website). ## Contributions -Any contribution is welcome. If you want to test the website in your own machine to help on this, make sure you have node.js installed, then clone the project repo and do the command: -`npm i` +Any contribution is welcome. If you want to test the website in your own machine to help on this, make sure you have Node.js installed, then clone the project repo and run the following commands: -Then it will be available at localhost://5173. +### NPM + +- `npm i` - Install dependencies +- `npm run dev` - Run dev server + +### Bun + +- `bun install` - Install dependencies +- `bun dev` - Run dev server + +The development server will be available at http://localhost:5173. ## Special Thanks + - [Aidan](https://github.com/ihatenodejs) - [lucmsilva](https://github.com/lucmsilva651/) -- [NineTailedFox] +- NineTailedFox -Enjoy! \ No newline at end of file +**Enjoy!**