Skip to content

A README.md template and MIT License for starting projects

License

Notifications You must be signed in to change notification settings

CallumBindley/readme-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Project Title

A short 1-2 sentence description of the project.

#

Table of Contents

About

  • Description

    Author : Callum Bindley
    Version : 2019.12.22
    Languages Used : HTML, CSS, JavaScript, etc

    A full description of the project in long form.
    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed a justo elit. Sed scelerisque consectetur rutrum. Vestibulum erat ante, tincidunt quis porttitor vitae, efficitur non massa. Morbi pharetra tempus lacus. Nunc efficitur ante erat, id sodales est rhoncus sollicitudin. Nullam eget magna vel dolor mattis iaculis. Morbi sit amet magna est. Sed interdum eu nisl ut gravida. Maecenas nec lectus quis lorem convallis semper.

  • Key Features

    Lorem ipsum dolor sit amet, consectetur adipiscing elit.
    Lorem ipsum dolor sit amet, consectetur adipiscing elit.
    Lorem ipsum dolor sit amet, consectetur adipiscing elit.
    Lorem ipsum dolor sit amet, consectetur adipiscing elit.

  • Showcase

    Examples of the project such as screenshots, links, gifs, video.

# # # # # #

Getting Started

  • Requirements

    any required software or version

  • Installation

    Description of steps required to get project to run

  • How to Use

    Description of how to use the project with demonstrated examples. Where possible use a gif or link to a video showing it.

  • API

    Description of how to use the API

Contributing

Please take a look at our contributing guidelines if you're interested in helping!

License

This project is free to use under the terms of the MIT license.

Resources

Support

Buy Me A Coffee

Patreon donate button

About

A README.md template and MIT License for starting projects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published