hoelee/Best-README-Template
1
0
Fork 0
mirror of https://github.com/othneildrew/Best-README-Template.git synced 2026-10-12 12:16:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
* Comment use of [reference-style links](https://github.com/othneildrew/Best-README-Template/issues/2) in the markdown
* Add a "roadmap" section, inspired by [the Cayman theme](https://github.com/pages-themes/cayman#roadmap)
* Add `[build-url]` and `[contributors-url]` references in the markdown
This commit is contained in:
Doug Ayers
2019-06-07 00:29:24 -05:00
committed by GitHub
parent 4311e45aa2
commit 85527b5ec8
1 changed files with 20 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+20 -2
View File
@@ -10,8 +10,15 @@
<!-- PROJECT SHIELDS -->
[![Build Status][build-shield]]()
[![Contributors][contributors-shield]]()
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for build-url, contributors-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
[![Build Status][build-shield]][build-url]
[![Contributors][contributors-shield]][contributors-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
@@ -51,6 +58,7 @@
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Usage](#usage)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
@@ -123,6 +131,13 @@ _For more examples, please refer to the [Documentation](https://example.com)_
<!-- ROADMAP -->
## Roadmap
See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a list of proposed features (and known issues).
<!-- CONTRIBUTING -->
## Contributing
@@ -171,8 +186,11 @@ Project Link: [https://github.com/your_username/repo_name](https://github.com/yo
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[build-shield]: https://img.shields.io/badge/build-passing-brightgreen.svg?style=flat-square
[build-url]: #
[contributors-shield]: https://img.shields.io/badge/contributors-1-orange.svg?style=flat-square
[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors
[license-shield]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
[license-url]: https://choosealicense.com/licenses/mit
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555