Breef introduction about the application, it's purpose and how it work.
Project requirements (os, language version and any other relevant).
Example:
ProjectTemplate requires iOS 10.0 or above, Xcode 10.0 or above and is compatibile with Swift 4/5.
List here the features - what your lib has to offer
- Feature 01
- Feature 02
- Feature 03
Add here an installation guide.
Add here an installation guide.
Maybe it's good to have some quickstart code. A code that that is ready to use right away (just copy and paste inside a new project)
function main() {
...
const myLib = new myLib();
myLib.coolFeature();
}
Here you can inform how to use the application basics (optional).
Maybe you can list some code examples for each feature (optional).
function main() {
...
mylib.coolFeature();
}
- Created by Tulio Parreiras
- Tulio Parreiras, [email protected]
Bug reports and pull requests are welcome on GitHub
- Banco de dados MySQL 5.7
- Frontend web desacoplado:
- React.js
- Backbone.js
- Webpack
- Ubuntu 18.04 ou superior
- imagic
The project is available as open source under the terms of the MIT License.