Skip to content

Instantly share code, notes, and snippets.

@ivancorrales

ivancorrales/README.md

Last active December 27, 2018 07:23
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save ivancorrales/068b7d15ece64ff1ab64aa21ed88f067 to your computer and use it in GitHub Desktop.
Save ivancorrales/068b7d15ece64ff1ab64aa21ed88f067 to your computer and use it in GitHub Desktop.
Download ZIP
A nice example of README.md for your project
Raw
README.md

[](--- 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