Skip to content
This repository has been archived by the owner on Aug 8, 2018. It is now read-only.
/ readme-bolierplate Public archive

Note: The maintained version of this readme.md template can be found at https://github.com/hinell/project-boilerplate

License

Notifications You must be signed in to change notification settings

hinell/readme-bolierplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 

Repository files navigation

PROJECT

INSTALL | USAGE | API | AUTHOR | CONTRIBUTE | LICENSE | SUPPORT

KISS - Keep it simple, stupid!

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

MOTIVATION

Description of the problem that your module solves.

GETTING STARTED

A brief note on environment/machine/tools requisites

INSTALLATION

Installation/deployment example

USAGE

Give more elaborate example here.

API

WARNING!:

Api description should be given here.

Code examples ...

AUTHOR

You can follow me on twitter or just email me.

ACKNOWLEDGMENTS

List of people and project that inspired creation of this one:

  • @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 & 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 project description

Copyright © 2017 Davronov Alexander

Releases

No releases published

Sponsor this project

Packages

No packages published