Welcome to readme-generator 🚀

Create README.md now with readme-generator 1.0 🚀 Done!

Description   |    Project   |    Technologies   |    Layout   |    How to use   |    How to contribute   |    License

✍ Description: What is my project about??

This readme.md was created with the readme-generator, simple, easy and functional. You can try to generate your logo here below with the installation example.

// Example generate in vscode
> ts-node src/index.ts

💻 Project Estructure

📂 -- src
    |-- index.ts
    |-- structure.txt
    📂 -- dist
        |-- README.md
    📂 -- functions
        |-- cli.ts
        |-- generated_arquive.ts
    📂 -- layouts
        |-- layout.md
    📂 -- util
        |-- generateFolders.ts

🛸 Technologies

This project was developed with the following technologies:

• Node.js
• TypeScript
• EJS

🧰 How To Use

To clone and run this application, you'll need Git, Node.js + Yarn installed on your computer.

From your command line:

📥 Install cmd

# Clone this repository
$ git clone https://github.com/brunobach/readme-generator/

# Go into the repository
$ cd readme-generator

# Install dependencies
$ yarn install

📲 Or scan QR code on device

🤔 How to contribute

• Make a fork;
• Create a branch with your feature: git checkout -b my-feature;
• Commit changes: git commit -m 'feat: My new feature';
• Make a push to your branch: git push origin my-feature.

After merging your receipt request to done, you can delete a branch from yours

📝 License

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

Made with ♥ by Bruno Bach 👋 Get in touch!