chore: improve Readme

README.md

@@ -1,14 +1,20 @@
-# Yasmin´s dotfiles
+<img
+    src="images/banner.png"
+    alt="My dotfiles is now installed!"
+/>
+
+# Yasmin's dotfiles
 
 Welcome to my dotfiles repository!
 
-This project is a curated collection of configuration files and scripts tailored to enhance my daily development experience.
+My dotfiles are designed to simplify my workflow, customize my development environment, and improve my daily development experience.
 
-My dotfiles are designed to simplify my workflow, customize my development environment, and ensure a consistent configuration.
+> [!WARNING]
+> Note that I use this project to save my configuration files for personal use. Some of them may not work for you.
 
 ## Installation
 
-Insert this into a macOS Terminal or Linux shell prompt. The script will detail its actions and then halt before executing them.
+Insert this into a macOS terminal. The script will detail its actions and then halt before executing them.
 
 ```bash
   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/YasminTeles/dotfiles/main/install.sh)"
@@ -18,12 +24,10 @@ Insert this into a macOS Terminal or Linux shell prompt. The script will detail
 
 All my command-line tools, applications, and their configurations. Have fun 😎💅
 
-- Git
-- Stow
-- Oh My Zsh
-- SSH key generation
-- Create a Projects folder
-- A bunch of productivity apps. See [Brewfile](/brew/Brewfile) for more information.
+- iTerm, zsh and Oh My Zsh. Spaceship for theme.
+- Git and SSH key generation. See [gitconfig](/git/.gitconfig) for more information about my Git aliases.
+- Create a Projects folder. For clone all projects in GitHub, try `make github`.
+- Homebrew and a bunch of productivity apps. See [Brewfile](/brew/Brewfile) for more information.
 
 ## Helper
 
@@ -37,9 +41,7 @@ A set of environment management commands is available at `Makefile`. To access t
 
 This script is designed to remove all configurations of your environment. **Please proceed with caution** as this action is irreversible.
 
-### Instructions
-
-Enter this command into a macOS Terminal or Linux shell prompt. The script will outline its actions.
+Enter this command into a macOS terminal. The script will outline its actions.
 
 ```bash
   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/YasminTeles/dotfiles/main/uninstall.sh)"
@@ -48,8 +50,6 @@ Enter this command into a macOS Terminal or Linux shell prompt. The script will
 > [!CAUTION]
 > Ensure you have **backups** of any important configurations before running this script.
 
-By following these steps, you can safely remove all configurations of the environment as needed.
-
 ## License
 
 This project is licensed under the [MIT License](LICENSE).