From b75b81e402211d5c5c21830ffc01ebddd40ec623 Mon Sep 17 00:00:00 2001 From: GiovaniFZ Date: Sun, 2 Feb 2025 17:16:47 -0300 Subject: [PATCH] docs: Improve README.md --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ee5d7b8..be00e09 100644 --- a/README.md +++ b/README.md @@ -1 +1,22 @@ -# my-website \ No newline at end of file +# my-website + +## Introduction +Hey, this is my website! The "Giv's website" + +## Used Technologies +- React +- TypeScript +- Vite + +## How to access? +If you want to check the deploy, visit the project repo on [Github](https://github.com/GiovaniFZ/my-website). +The access link will be availble on link section. + +## 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` + +Then it will be available at localhost://5173. + +Enjoy! \ No newline at end of file