marco-fuchs/read-me-template

This is a template to be used when creating ReadMe files for your Github repositories.

Read Me Template

This is a ReadMe template to help save you time and effort.

---

Table of Contents

You're sections headers will be used to reference location of destination.

• Description
• How To Use
• References
• License
• Author Info

---

Description

Creating ReadMe's for your Github repository can be tedious. I hope this template can save you time and effort as well as provide you with some consistency across your projects.

Technologies

• Technology 1
• Technology 2

Back To The Top

---

How To Use

Installation

API Reference

    <p>dummy code</p>

Back To The Top

---

References

Back To The Top

---

License

MIT License

Copyright (c) [2017] [James Q Quick]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Back To The Top

---

Author Info

• Twitter - @jamesqquick
• Website - James Q Quick

Back To The Top

Our favorite Magic Command %md allows us to render Markdown in a cell:

• Double click this cell to begin editing it
• Then hit Esc to stop editing

Title One

Title Two

Title Three

This is a test of the emergency broadcast system. This is only a test.

This is text with a bold word in it.

This is text with an italicized word in it.

This is an ordered list 0. once 0. two 0. three

This is an unordered list

• apples
• peaches
• bananas

Links/Embedded HTML: What is Markdown?

Images:

And of course, tables:

Name	Age	Sex
Tom	32	Male
Mary	29	Female
Dick	73	Male
Sally	55	Female