/project-boilerplate

scaffolding for the web-app project

Primary LanguageTypeScript

PROJECT

INSTALL | USAGE | API | TROUBLE | AUTHOR | CONTRIB | TESTS | LICENSE | SUPPORT

This project was generated by using bolierplate-project


KISS - Keep it simple, stupid!
DRY - Don't repeat yourself!

Quick usage example... repeat until it gets clear.

MOTIVATION

Describe what the problem your package/project solves.

GETTING STARTED

A brief note on environment/machine/tools requirements

INSTALLATION

Installation/deployment example

USAGE

Give more elaborate example here.

TROUBLESHOOTING

Describe how to troubleshoot whatever here...

API

WARNING!:

Api description should be given here.

Code examples ...

AUTHOR

You can follow me on twitter or just email me.

ACKNOWLEDGMENTS

  • @PurpleBooth for his readme template posted here
  • @jxson for his readme example as well.
  • Github guides for their precious documenting your project article concerning readme creation

CONTRIBUTION

TESTING

Describe how to test your project

LICENSE

Check out (if any) contribution guide or license for more details.

PRODUCTION STATUS & SUPPORT

You should be aware that this project is supported solely by me and provided as is.
If you want to become a patron or offer me a support please follow here.


Go back to the top | This project was generated by using bolierplate-project


Copyright © 2019 Alexander Darvonov