README.md

Title

Overview • Screenshot • Demo • Documentation

📑 Menu

• Overview
• Screenshot
• Demo
• Documentation
• Requirements
• Installation and usage
  • Tests
  • Dependencies and libs
  • Folder Structure
• Release History
• Contributing
  • Tasks
• License
• Author

📜 Overview

Lorem ipsum dolor sit amet consectetur, adipisicing elit. Aut praesentium neque assumenda! Tempore culpa nihil laborum distinctio vel, illo quod veniam. Excepturi soluta beatae sed iusto sunt, impedit ducimus dignissimos?

🎑 Screenshot

📀 Demo

Lorem ipsum dolor sit amet consectetur, adipisicing elit.

url	login	password
http://exemplo.com/admin	admin@mail.com	123

📘 Documentation

Documentation lives at readthedocs.org

❗ Requirements

• Node
• PHP

💾 Installation and usage

git clone https://github.com/<user>/<project>

🚨 Tests

$ eslint scripts --fix
$ npm run test

✔️ Dependencies and libs

• React
• React PDF

📂 Folder Structure

.
├── src           # Project source code
├── doc           # Doc for the project
├── .gitignore
├── LICENSE
└── README.md

🎁 Release History

• 0.2.0
  • CHANGE: Remove function
  • ADD: Add init()
• 0.1.1
  • FIX: Crash when calling baz()
• 0.1.0
  • CHANGE: Rename foo() to bar()
• 0.0.1
  • Init the project

😻 Contributing

Steps to contribute:

• Fork it (https://github.com/yourname/yourproject/fork);
• Create your feature branch (git checkout -b feature/fooBar);
• Commit your changes (git commit -am 'Add some fooBar');
• Push to the branch (git push origin feature/fooBar);
• Create a new Pull Request;

🔔 Tasks

Task list:

• Task 1
• Task 2
• Task 3
• Task 4

📝 License

The MIT License (MIT)

😺 Author

• @walternascimentobarroso

Made with  ❤️