Skip to content

Instantly share code, notes, and snippets.

@ivancorrales ivancorrales/README.md
Last active Dec 27, 2018

Embed
What would you like to do?
A nice example of README.md for your project

[](--- badges go here ---)

Project Title

One or more paragraphs of project description goes here

Getting Started

Installing

Define how make use of this project.

Usage

Sample of use of your project. Your examples should be described.

Running tests

Describe steps to run the tests.

Benchmark

Link to the benchmark reports of your project

Guides & Tutorials

List of published guides and tutorials that demonstrate how to use your project.

Contributing

Link to CONTRIBUTING.md

Roadmap

A link to the document with roadmap of your project.

License

Link to LICENSE.md

Support

Let people know how the can contact to you (email, slack,...).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.