Skip to content

Instantly share code, notes, and snippets.

@satwikkansal satwikkansal/README.md
Last active Aug 11, 2017

Embed
What would you like to do?
Github README.rst and README.md styles

// Header Design 1

Project Name

A one line description of the project.

Check It Out! | Read the Docs

// Header Design 2

Project Name

One line description of the project.

// Repo badges

Awesome Travis Build Status Appveyor Build Status NPM version Join the chat at https://gitter.im/{ORG-or-USERNAME}/{REPO-NAME} GitHub forks GitHub stars GitHub tag GitHub release

// Project Logo

logo

// Project Video

vido_thumbnail

// Body

Prerequisites

Mention what things you need to install the software and how to install them.

Add commands and links required.

Installation

> describe the installation instructions

Usage

Basic usage instructions to help people to just get started using your project.

Contributing

All patches welcome! Please read CONTRIBUTING.md for furthers details.

License

LICENSE NAME - see the LICENSE.md file for details

// or

License

Acknowledgements

  • Inspiration
  • People who helped
  • References to code reused
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.