Merge pull request #57 from gabrielduete/chore/update-readme

chore: update readme

README.md

@@ -1,8 +1,47 @@
-# [🏃Work in progress...🏃‍♂️] Sandevistan: My Virtual Library of Software Engineering Studies
-
-# Figma [Work in progress...]
-![Sandevistan](https://github.com/gabrielduete/sandevistan/assets/59345698/7d92b782-b9c7-48a0-b164-7cd9d7bba83d)
-![Home - desktop](https://github.com/gabrielduete/sandevistan/assets/59345698/7c264e7c-267f-4e80-aa31-13fb12d0a0fa)
-![Home - Mobile](https://github.com/gabrielduete/sandevistan/assets/59345698/0837733e-bcaf-4e18-aea9-e1529941ba3f)
-![Home - desktop](https://github.com/gabrielduete/sandevistan/assets/59345698/4fd9b633-07f7-4d8b-917e-5edf0638c79b)
-![About - mobile](https://github.com/gabrielduete/sandevistan/assets/59345698/563390f9-f758-4126-ad46-bca364138110)
+# Sandevistan: My Virtual Library of Software Engineering Studies
+
+My Virtual Library of Software Engineering Studies. This project aims to document all my studies that will be stored on this Notion page. It will be automatically updated whenever I make any changes.
+
+The name of the project was inspired by the Sandevistan Operating System implant from the Cyberpunk 2077 game. It was my favorite implant during my gameplay. This implant can "stop" time and make everything slow, except the user, which is somewhat similar to this project, as if I stopped time to go back and review something I studied and left documented. I was out of ideas for what name to put, and this came to mind.
+
+The back-end of the project is in a private repository, due to security and private credentials.
+
+[Live project](https://sandevistan.vercel.app/)
+
+# About ![Figma](https://www.figma.com/design/rzmZtdsd6DjSg6cKd65ncr/Sandevistan?node-id=0-1&t=fhVuwPX60IaJHPw7-1) and Design Idea
+
+### Color pallete
+
+The choice of colors was created thinking about both the color palette that I already use as my profile photo, and the colors that reference sandevistan.
+
+Then, colors were selected from the hexadecimal colors `#1A3038` and `#122226`, from which the weakest and strongest colors were generated, composing the same palette.
+
+![Color pallete](https://github.com/gabrielduete/sandevistan/assets/59345698/7d92b782-b9c7-48a0-b164-7cd9d7bba83d)
+
+### UI/UX
+
+I wanted to follow a more minimalist and futuristic idea, so the home is simple, but with a glitch animation, which refers to a futuristic environment.
+
+On the content page, I only used the Raleway font, to be simple to view and with few details, as the aim is to be able to read the items correctly.
+
+#### Home
+| Desktop | Mobile |
+|----------|----------|
+| ![Page Home - desktop](https://github.com/user-attachments/assets/ae8c86d0-45b9-4926-9ef8-ba221f31cb66) | ![Page Home - Mobile](https://github.com/user-attachments/assets/bbf591d8-14b7-4bf3-9fd0-443b51b3c1ce) |
+
+#### About/Contents
+| Desktop | Mobile |
+|----------|----------|
+| ![Page About/Contents Destktop](https://github.com/user-attachments/assets/0c750fd2-4e6c-4c3d-90ff-bdd33829dc47) | ![Page About/Contents Mobile](https://github.com/user-attachments/assets/2533c28c-e786-4166-a915-0e8ba6fd6f14) |
+
+### How to run
+
+1. Clone repository
+2. Go to the project directory
+3. Run `yarn` to install dependecies
+4. Run `yarn dev` to run the project
+
+### How to contribute
+
+You can contribute in two ways: open issue or PR. 
+[Use this guia](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project).