From b517ca5922ea5defcdfbc75dce973563af8b754f Mon Sep 17 00:00:00 2001 From: Doug Ayers <4142577+douglascayers@users.noreply.github.com> Date: Fri, 7 Jun 2019 00:29:59 -0500 Subject: [PATCH 1/2] Update README.md * 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 --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 020c1917..7d79cd98 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,15 @@ -[![Build Status][build-shield]]() -[![Contributors][contributors-shield]]() + +[![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 + +See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a list of proposed features (and known issues). + + + ## Contributing @@ -171,8 +186,11 @@ Project Link: [https://github.com/your_username/repo_name](https://github.com/yo + [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 From 429cc7ee909f047fdee255cb0c20d965c2da558c Mon Sep 17 00:00:00 2001 From: Doug Ayers <4142577+douglascayers@users.noreply.github.com> Date: Fri, 7 Jun 2019 00:48:18 -0500 Subject: [PATCH 2/2] Add missing single quote to commit example --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7d79cd98..4ef15d0e 100644 --- a/README.md +++ b/README.md @@ -145,7 +145,7 @@ Contributions are what make the open source community such an amazing place to b 1. Fork the Project 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) -3. Commit your Changes (`git commit -m 'Add some AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) 4. Push to the Branch (`git push origin feature/AmazingFeature`) 5. Open a Pull Request