my-readme-template

README.md

Your cool project

Description   |    Getting Started   |    What's inside?   |    License

under construction...

📋 Description

Describe your application and what you learning with it. 😃

🚀 Getting Started

1. Download the repository

• Using Git

  git clone https://github.com/<your-login>/<repository>.git

• Using Github CLI

  gh repo clone <your-login>/<repository>

💡 or whichever way you prefer

2. Installation

3. Execution

🧐 What's inside?

🏗️ Technologies

• technology name

💄 Linter tools

• tool name

📦 Packages

• package name

A quick look at the top-level directories inside the ./src.

./src
 ├── assets
 ├── pages
 ├── styles
 ├── other-folder

1. assets: all resources used. How icons, images, etc.

2. pages: each file is a website page.

3. styles: global styles.

4. other-folder: add all folders when incorporation your application.

📝 License

This project is under the MIT license. See the file LICENSE for more details.

---

Build with 💙 By your name

Based on the readme template by Henrique Miranda