From 0415bec863b7db0d8410a1abfa73e43e217cf583 Mon Sep 17 00:00:00 2001
From: joaoofreitas <joaoofreitas00@gmail.com>
Date: Sat, 27 Mar 2021 18:20:24 +0000
Subject: [PATCH] =?UTF-8?q?README=20Update=20=F0=9F=93=84?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 77 +++++++++++++++++++++++++++++++++++++++++--------------
 1 file changed, 58 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index 6b19beb..8c92cab 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,9 @@
-<!-- PROJECT LOGO -->
 <br />
 <p align="center">
   <a href="https://github.com/joaoofreitas/challenge-generator">
-    <img src="" alt="Logo" width="80" height="80">
+    <img src="https://raw.githubusercontent.com/egonelbre/gophers/master/vector/superhero/standing.svg" alt="Logo" width="120" height="120">
   </a>
-
+</br>
   <h3 align="center">Challenge Generator</h3>
 
   <p align="center">
@@ -26,35 +25,75 @@
 ## Table of Contents
 
 * [About the Project](#about-the-project)
-    * [Built With](#built-with)
+  * [Built With](#built-with)
 * [Getting Started](#getting-started)
-    * [Prerequisites](#prerequisites)
-    * [Installation](#installation)
-* [Usage](#usage)
+  * [Download](#download)
+  * [Usage](#usage)
 * [Contributing](#contributing)
 * [License](#license)
 * [Contact](#contact)
-* [Acknowledgements](#acknowledgements)
+* [Acknowledgments](#acknowledgments)
 
 
 
-## About The Project
+## About The Project 🤠
 
 This project was created just for fun since I wanted to follow [_Karan's_](https://github.com/karan) projects that are in [_this_](https://github.com/karan/Projects) repository.
 
 Before starting with the projects I realized that I'm too lazy to generate a whole file structure to separate and isolate the projects. So I decided to make a program to do it for me.
 
-This program fetches this URL:
-[https://raw.githubusercontent.com/karan/Projects/master/README.md](https://raw.githubusercontent.com/karan/Projects/master/README.md) and parses it separating subjects from exercises, names and descriptions into a structure and the whole project structure.
-
-
-### Built With
+This program fetches [this](https://raw.githubusercontent.com/karan/Projects/master/README.md) URL and parses it separating subjects, exercises, names, and descriptions into a structure that will be the gate for generating a file structure like this:
+
+```bash
+📦Project Learning
+ ┣ 📂Classes
+ ┃ ┣ 📂AirlineHotelReservationSystem
+ ┃ ┃ ┗ 📜README.md
+ ┃ ┣ 📂BankAccountManager
+ ┃ ┃ ┗ 📜README.md
+ ┃ ┣ 📂CompanyManager
+ ┃ ┃ ┗ 📜README.md
+ ┃ ┣ 📂FamilyTreeCreator
+ ┃ ┃ ┗ 📜README.md
+ ┃ ┣ 📂FlowerShopOrderingToGo
+ ┃ ┃ ┗ 📜README.md
+ ┃ ┣ 📂ImageGallery
+ ┃ ┃ ┗ 📜README.md
+ ┣ 📂ClassicAlgorithms
+ ┃ ┣ 📂Closestpairproblem
+ ┃ ┃ ┗ 📜README.md
+ ┃ ┣ 📂CollatzConjecture
+ ┃ ┃ ┗ 📜README.md
+ ┃ ┣ 📂SieveofEratosthenes
+ ┃ ┃ ┗ 📜README.md
+ ┃ ┗ 📂Sorting
+ ┃ ┃ ┗ 📜README.md
+```
+
+### Built With 🔨
 
 This program is built purely with [Go](https://golang.org/). No need for extra libraries or any bloated stuff. Minimal and simple.
 
 I've chosen [Go](https://golang.org/) since it's one of the programming languages that I enjoy most.
 
-<!-- ROADMAP -->
+## Download 📥
+
+This program was meant to be compiled into a single executable. You can download it on my [_releases_](https://github.com/joaoofreitas/challenge-generator/releases) page and download the specific version for your platform.
+
+## Usage 💻
+
+For using this program, simply double-clicking would do the job, but if you want to see the logs properly you can run it in the terminal using:
+
+``` bash
+./path_to_executable_file
+```
+
+The base directory by default will have the name "Project Learning", but you can change before being generated by putting the name of the base directory as an argument:
+
+``` bash
+./path_to_executable_file <nameOfTheProjectBaseDir>
+```
+
 ## 🚧 Roadmap
 
 See the [open issues](https://github.com/joaoofreitas/challenge-generator/issues) for a list of proposed features (and known issues).
@@ -62,11 +101,11 @@ See the [open issues](https://github.com/joaoofreitas/challenge-generator/issues
 
 ## 🤝 Contributing
 
-Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **extremely appreciated**.
+Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **extremely appreciated**.
 
 1. Fork the Project
 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
-3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
 4. Push to the Branch (`git push origin feature/AmazingFeature`)
 5. Open a Pull Request
 
@@ -77,9 +116,9 @@ Distributed under the MIT License. Check `LICENSE` for more information.
 
 ## 📫 Contact
 
-João Freitas - <a href="mailto:joaoofreitas@pm.me">Email</a>
+João Freitas - <a href="mailto:joaoofreitas@pm.me">_Contact me_</a>
 
 
-## Acknowledgements
+## Acknowledgments
 
 Huge thanks to [Karan](https://github.com/karan) for creating the README.
\ No newline at end of file