From fe9bfc535f18a7209bf5f28e5a91f520bfecf573 Mon Sep 17 00:00:00 2001
From: Yasmin Teles <teles.yasmin.tech@gmail.com>
Date: Sun, 7 Apr 2024 21:01:27 -0300
Subject: [PATCH] chore: improve Readme

---
 README.md | 21 ++++++++++-----------
 1 file changed, 10 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index ce4a75a..6c479f8 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,15 @@
-# Yasmin´s dotfiles
+# 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 +19,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.
+- 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
 
@@ -39,7 +38,7 @@ This script is designed to remove all configurations of your environment. **Plea
 
 ### 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)"