Skip to content

Instantly share code, notes, and snippets.

@josemcunha

josemcunha/README-Template.md

Forked from PurpleBooth/README-Template.md
Last active December 19, 2020 11:06
Show Gist options
  • Star 3 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save josemcunha/d0c6704bb30adbf6ad43f7e1a7c7aa53 to your computer and use it in GitHub Desktop.
Save josemcunha/d0c6704bb30adbf6ad43f7e1a7c7aa53 to your computer and use it in GitHub Desktop.
Download ZIP
A template to make good README.md
Raw
README-Template.md

Project Title

One Paragraph of project description goes here. Don't forget to link back to the tutorial.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Give examples

Built With

  • Pusher - APIs to enable devs building realtime features
  • Maven - Dependency Management
  • ROME - Used to generate RSS Feeds

Acknowledgments

  • Hat tip to anyone who's code was used
  • Inspiration
  • etc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment