From 59083258b15002176a3a6116ca06be2d39ba61be Mon Sep 17 00:00:00 2001 From: actuarysailor <24359398+actuarysailor@users.noreply.github.com> Date: Sat, 9 Aug 2025 16:56:58 -0400 Subject: [PATCH 1/3] chore: Address Linting Issues --- README.md | 59 +++++++++++++++++++++---------------------------------- 1 file changed, 22 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index b36d4fd..50c1c16 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,6 @@ *** Thanks again! Now go create something AMAZING! :D --> - -
@@ -50,8 +46,6 @@

- -
Table of Contents @@ -78,8 +72,6 @@
- - ## About The Project @@ -88,6 +80,7 @@ There are many great README templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it. Here's why: + * Your time should be focused on creating something amazing. A project that solves a problem and helps others * You shouldn't be doing the same tasks over and over like creating a README from scratch * You should implement DRY principles to the rest of your life :smile: @@ -98,8 +91,6 @@ Use the `BLANK_README.md` to get started.

(back to top)

- - ### Built With This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples. @@ -115,8 +106,6 @@ This section should list any major frameworks/libraries used to bootstrap your p

(back to top)

- - ## Getting Started @@ -126,7 +115,9 @@ To get a local copy up and running follow these simple example steps. ### Prerequisites This is an example of how to list things you need to use the software and how to install them. + * npm + ```sh npm install npm@latest -g ``` @@ -137,18 +128,25 @@ _Below is an example of how you can instruct your audience on installing and set 1. Get a free API Key at [https://example.com](https://example.com) 2. Clone the repo + ```sh git clone https://github.com/github_username/repo_name.git ``` + 3. Install NPM packages + ```sh npm install ``` + 4. Enter your API in `config.js` + ```js const API_KEY = 'ENTER YOUR API'; ``` + 5. Change git remote url to avoid accidental pushes to base project + ```sh git remote set-url origin github_username/repo_name git remote -v # confirm the changes @@ -156,8 +154,6 @@ _Below is an example of how you can instruct your audience on installing and set

(back to top)

- - ## Usage @@ -167,25 +163,21 @@ _For more examples, please refer to the [Documentation](https://example.com)_

(back to top)

- - ## Roadmap -- [x] Add Changelog -- [x] Add back to top links -- [ ] Add Additional Templates w/ Examples -- [ ] Add "components" document to easily copy & paste sections of the readme -- [ ] Multi-language Support - - [ ] Chinese - - [ ] Spanish +* [x] Add Changelog +* [x] Add back to top links +* [ ] Add Additional Templates w/ Examples +* [ ] Add "components" document to easily copy & paste sections of the readme +* [ ] Multi-language Support + * [ ] Chinese + * [ ] Spanish See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a full list of proposed features (and known issues).

(back to top)

- - ## Contributing @@ -200,7 +192,7 @@ Don't forget to give the project a star! Thanks again! 4. Push to the Branch (`git push origin feature/AmazingFeature`) 5. Open a Pull Request -### Top contributors: +### Top contributors contrib.rocks image @@ -208,8 +200,6 @@ Don't forget to give the project a star! Thanks again!

(back to top)

- - ## License @@ -217,19 +207,16 @@ Distributed under the Unlicense License. See `LICENSE.txt` for more information.

(back to top)

- - ## Contact -Your Name - [@your_twitter](https://twitter.com/your_username) - email@example.com - +Your Name \ +𝕏[@your_twitter](https://twitter.com/your_username) \ +📧[email@example.com](mailto:email@example.com) \ Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name)

(back to top)

- - ## Acknowledgments @@ -246,8 +233,6 @@ Use this space to list resources you find helpful and would like to give credit

(back to top)

- - [contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge @@ -278,4 +263,4 @@ Use this space to list resources you find helpful and would like to give credit [Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white [Bootstrap-url]: https://getbootstrap.com [JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white -[JQuery-url]: https://jquery.com +[JQuery-url]: https://jquery.com From edd3504357f33506d7695ed7264cf97e3e6dd740 Mon Sep 17 00:00:00 2001 From: actuarysailor <24359398+actuarysailor@users.noreply.github.com> Date: Sat, 9 Aug 2025 17:13:32 -0400 Subject: [PATCH 2/3] chore: No markdown linting errors --- .markdownlint.json | 32 ++++++++++ README.md | 152 +++++++++++++++++++++++++++++---------------- 2 files changed, 130 insertions(+), 54 deletions(-) create mode 100644 .markdownlint.json diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..2d9cab0 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,32 @@ +{ + "MD013": { + "line_length": 80, + "code_blocks": false, + "tables": false, + "headings": false + }, + "MD033": { + "allowed_elements": [ + "a", + "div", + "img", + "h1", + "h2", + "h3", + "h4", + "h5", + "h6", + "p", + "br", + "strong", + "em", + "details", + "summary", + "ol", + "ul", + "li" + ] + }, + "MD041": false, + "MD034": false +} \ No newline at end of file diff --git a/README.md b/README.md index 50c1c16..c9c3170 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ - +# Best-README-Template + + + + [![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] @@ -24,7 +30,7 @@ [![LinkedIn][linkedin-shield]][linkedin-url] -
+
Logo @@ -35,18 +41,25 @@

An awesome README template to jumpstart your projects!
- Explore the docs » + + Explore the docs » +

View Demo - · - Report Bug - · - Request Feature + · + Report Bug + · + + Request Feature +

+
Table of Contents
    @@ -73,19 +86,28 @@
+ ## About The Project [![Product Name Screen Shot][product-screenshot]](https://example.com) -There are many great README templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it. +There are many great README templates available on GitHub; however, I didn't +find one that really suited my needs so I created this enhanced one. I want to +create a README template so amazing that it'll be the last one you ever need -- +I think this is it. Here's why: -* Your time should be focused on creating something amazing. A project that solves a problem and helps others -* You shouldn't be doing the same tasks over and over like creating a README from scratch -* You should implement DRY principles to the rest of your life :smile: +- Your time should be focused on creating something amazing. A project that + solves a problem and helps others +- You shouldn't be doing the same tasks over and over like creating a README + from scratch +- You should implement DRY principles to the rest of your life :smile: -Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template! +Of course, no one template will serve all projects since your needs may be +different. So I'll be adding more in the near future. You may also suggest +changes by forking this repo and creating a pull request or opening an issue. +Thanks to all the people have contributed to expanding this template! Use the `BLANK_README.md` to get started. @@ -93,30 +115,34 @@ Use the `BLANK_README.md` to get started. ### Built With -This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples. +This section should list any major frameworks/libraries used to bootstrap your +project. Leave any add-ons/plugins for the acknowledgements section. Here are a +few examples. -* [![Next][Next.js]][Next-url] -* [![React][React.js]][React-url] -* [![Vue][Vue.js]][Vue-url] -* [![Angular][Angular.io]][Angular-url] -* [![Svelte][Svelte.dev]][Svelte-url] -* [![Laravel][Laravel.com]][Laravel-url] -* [![Bootstrap][Bootstrap.com]][Bootstrap-url] -* [![JQuery][JQuery.com]][JQuery-url] +- [![Next][Next.js]][Next-url] +- [![React][React.js]][React-url] +- [![Vue][Vue.js]][Vue-url] +- [![Angular][Angular.io]][Angular-url] +- [![Svelte][Svelte.dev]][Svelte-url] +- [![Laravel][Laravel.com]][Laravel-url] +- [![Bootstrap][Bootstrap.com]][Bootstrap-url] +- [![JQuery][JQuery.com]][JQuery-url]

(back to top)

+ ## Getting Started -This is an example of how you may give instructions on setting up your project locally. -To get a local copy up and running follow these simple example steps. +This is an example of how you may give instructions on setting up your project +locally. To get a local copy up and running follow these simple example steps. ### Prerequisites -This is an example of how to list things you need to use the software and how to install them. +This is an example of how to list things you need to use the software and how +to install them. -* npm +- npm ```sh npm install npm@latest -g @@ -124,9 +150,11 @@ This is an example of how to list things you need to use the software and how to ### Installation -_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._ +_Below is an example of how you can instruct your audience on installing and +setting up your app. This template doesn't rely on any external dependencies +or services._ -1. Get a free API Key at [https://example.com](https://example.com) +1. Get a free API Key at 2. Clone the repo ```sh @@ -155,36 +183,44 @@ _Below is an example of how you can instruct your audience on installing and set

(back to top)

+ ## Usage -Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. +Use this space to show useful examples of how a project can be used. Additional +screenshots, code examples and demos work well in this space. You may also link +to more resources. _For more examples, please refer to the [Documentation](https://example.com)_

(back to top)

+ ## Roadmap -* [x] Add Changelog -* [x] Add back to top links -* [ ] Add Additional Templates w/ Examples -* [ ] Add "components" document to easily copy & paste sections of the readme -* [ ] Multi-language Support - * [ ] Chinese - * [ ] Spanish +- [x] Add Changelog +- [x] Add back to top links +- [ ] Add Additional Templates w/ Examples +- [ ] Add "components" document to easily copy & paste sections of the readme +- [ ] Multi-language Support + - [ ] Chinese + - [ ] Spanish -See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a full list of proposed features (and known issues). +See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) +for a full list of proposed features (and known issues).

(back to top)

+ ## Contributing -Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. +Contributions are what make the open source community such an amazing place to +learn, inspire, and create. Any contributions you make are **greatly appreciated**. -If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". -Don't forget to give the project a star! Thanks again! +If you have a suggestion that would make this better, please fork the repo and +create a pull request. You can also simply open an issue with the tag +"enhancement". Don't forget to give the project a star! Thanks again! 1. Fork the Project 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) @@ -195,12 +231,16 @@ Don't forget to give the project a star! Thanks again! ### Top contributors - contrib.rocks image + contrib.rocks image

(back to top)

+ ## License Distributed under the Unlicense License. See `LICENSE.txt` for more information. @@ -208,33 +248,37 @@ Distributed under the Unlicense License. See `LICENSE.txt` for more information.

(back to top)

+ ## Contact -Your Name \ -𝕏[@your_twitter](https://twitter.com/your_username) \ -📧[email@example.com](mailto:email@example.com) \ -Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name) +Your Name +𝕏[@your_twitter](https://twitter.com/your_username) +📧[email@example.com](mailto:email@example.com) +Project Link:

(back to top)

+ ## Acknowledgments -Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off! +Use this space to list resources you find helpful and would like to give credit +to. I've included a few of my favorites to kick things off! -* [Choose an Open Source License](https://choosealicense.com) -* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) -* [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/) -* [Malven's Grid Cheatsheet](https://grid.malven.co/) -* [Img Shields](https://shields.io) -* [GitHub Pages](https://pages.github.com) -* [Font Awesome](https://fontawesome.com) -* [React Icons](https://react-icons.github.io/react-icons/search) +- [Choose an Open Source License](https://choosealicense.com) +- [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) +- [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/) +- [Malven's Grid Cheatsheet](https://grid.malven.co/) +- [Img Shields](https://shields.io) +- [GitHub Pages](https://pages.github.com) +- [Font Awesome](https://fontawesome.com) +- [React Icons](https://react-icons.github.io/react-icons/search)

(back to top)

+ [contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge [contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge From 1f79f523e87f9c8ff4c97ffdc636355b58b1ede2 Mon Sep 17 00:00:00 2001 From: actuarysailor <24359398+actuarysailor@users.noreply.github.com> Date: Sat, 9 Aug 2025 17:24:28 -0400 Subject: [PATCH 3/3] chore: Cleanup remaining linting issues --- .github/ISSUE_TEMPLATE/bug-report---.md | 11 +- .github/ISSUE_TEMPLATE/feature-request---.md | 5 +- BLANK_README.md | 140 +++++++++++-------- CHANGELOG.md | 17 +-- 4 files changed, 100 insertions(+), 73 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report---.md b/.github/ISSUE_TEMPLATE/bug-report---.md index e74e7d0..1aadaf7 100644 --- a/.github/ISSUE_TEMPLATE/bug-report---.md +++ b/.github/ISSUE_TEMPLATE/bug-report---.md @@ -6,17 +6,22 @@ labels: bug --- ## Describe the bug + A clear and concise description of what the bug is. ### Steps to reproduce + Steps to reproduce the behavior. ### Expected behavior + A clear and concise description of what you expected to happen. ### Environment - - OS: [e.g. Arch Linux] - - Other details that you think may affect. + +- OS: [e.g. Arch Linux] +- Other details that you think may affect. ### Additional context -Add any other context about the problem here. \ No newline at end of file + +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature-request---.md b/.github/ISSUE_TEMPLATE/feature-request---.md index 3bd987c..355cf62 100644 --- a/.github/ISSUE_TEMPLATE/feature-request---.md +++ b/.github/ISSUE_TEMPLATE/feature-request---.md @@ -6,10 +6,13 @@ labels: enhancement --- ## Summary + Brief explanation of the feature. ### Basic example + Include a basic example or links here. ### Motivation -Why are we doing this? What use cases does it support? What is the expected outcome? \ No newline at end of file + +Why are we doing this? What use cases does it support? What is the expected outcome? diff --git a/BLANK_README.md b/BLANK_README.md index 4553aa4..b1a5591 100644 --- a/BLANK_README.md +++ b/BLANK_README.md @@ -1,5 +1,9 @@ - +# project_title + + + - - + [![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] @@ -25,34 +29,40 @@ [![project_license][license-shield]][license-url] [![LinkedIn][linkedin-shield]][linkedin-url] - - +
Logo -

project_title

+

project_title

project_description
- Explore the docs » + + Explore the docs » +

View Demo - · - Report Bug - · - Request Feature + · + + Report Bug + + · + + Request Feature +

- - +
Table of Contents
    @@ -78,64 +88,73 @@
- - + ## About The Project [![Product Name Screen Shot][product-screenshot]](https://example.com) -Here's a blank template to get started. To avoid retyping too much info, do a search and replace with your text editor for the following: `github_username`, `repo_name`, `twitter_handle`, `linkedin_username`, `email_client`, `email`, `project_title`, `project_description`, `project_license` +Here's a blank template to get started. To avoid retyping too much info, do a +search and replace with your text editor for the following: `github_username`, +`repo_name`, `twitter_handle`, `linkedin_username`, `email_client`, `email`, +`project_title`, `project_description`, `project_license`

(back to top)

- - ### Built With -* [![Next][Next.js]][Next-url] -* [![React][React.js]][React-url] -* [![Vue][Vue.js]][Vue-url] -* [![Angular][Angular.io]][Angular-url] -* [![Svelte][Svelte.dev]][Svelte-url] -* [![Laravel][Laravel.com]][Laravel-url] -* [![Bootstrap][Bootstrap.com]][Bootstrap-url] -* [![JQuery][JQuery.com]][JQuery-url] +- [![Next][Next.js]][Next-url] +- [![React][React.js]][React-url] +- [![Vue][Vue.js]][Vue-url] +- [![Angular][Angular.io]][Angular-url] +- [![Svelte][Svelte.dev]][Svelte-url] +- [![Laravel][Laravel.com]][Laravel-url] +- [![Bootstrap][Bootstrap.com]][Bootstrap-url] +- [![JQuery][JQuery.com]][JQuery-url]

(back to top)

- - + ## Getting Started -This is an example of how you may give instructions on setting up your project locally. -To get a local copy up and running follow these simple example steps. +This is an example of how you may give instructions on setting up your project +locally. To get a local copy up and running follow these simple example steps. ### Prerequisites -This is an example of how to list things you need to use the software and how to install them. -* npm +This is an example of how to list things you need to use the software and how +to install them. + +- npm + ```sh npm install npm@latest -g ``` ### Installation -1. Get a free API Key at [https://example.com](https://example.com) +1. Get a free API Key at 2. Clone the repo + ```sh git clone https://github.com/github_username/repo_name.git ``` + 3. Install NPM packages + ```sh npm install ``` + 4. Enter your API in `config.js` + ```js const API_KEY = 'ENTER YOUR API'; ``` + 5. Change git remote url to avoid accidental pushes to base project + ```sh git remote set-url origin github_username/repo_name git remote -v # confirm the changes @@ -143,40 +162,42 @@ This is an example of how to list things you need to use the software and how to

(back to top)

- - + ## Usage -Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. +Use this space to show useful examples of how a project can be used. Additional +screenshots, code examples and demos work well in this space. You may also link +to more resources. _For more examples, please refer to the [Documentation](https://example.com)_

(back to top)

- - + ## Roadmap - [ ] Feature 1 - [ ] Feature 2 - [ ] Feature 3 - - [ ] Nested Feature + - [ ] Nested Feature -See the [open issues](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues). +See the [open issues](https://github.com/github_username/repo_name/issues) for +a full list of proposed features (and known issues).

(back to top)

- - + ## Contributing -Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. +Contributions are what make the open source community such an amazing place to +learn, inspire, and create. Any contributions you make are **greatly appreciated**. -If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". -Don't forget to give the project a star! Thanks again! +If you have a suggestion that would make this better, please fork the repo and +create a pull request. You can also simply open an issue with the tag +"enhancement". Don't forget to give the project a star! Thanks again! 1. Fork the Project 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) @@ -186,47 +207,44 @@ Don't forget to give the project a star! Thanks again!

(back to top)

-### Top contributors: +### Top contributors - contrib.rocks image + contrib.rocks image - - + ## License Distributed under the project_license. See `LICENSE.txt` for more information.

(back to top)

- - + ## Contact Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com -Project Link: [https://github.com/github_username/repo_name](https://github.com/github_username/repo_name) +Project Link:

(back to top)

- - + ## Acknowledgments -* []() -* []() -* []() +- []() +- []() +- []()

(back to top)

- - + [contributors-shield]: https://img.shields.io/github/contributors/github_username/repo_name.svg?style=for-the-badge [contributors-url]: https://github.com/github_username/repo_name/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/github_username/repo_name.svg?style=for-the-badge @@ -255,4 +273,4 @@ Project Link: [https://github.com/github_username/repo_name](https://github.com/ [Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white [Bootstrap-url]: https://getbootstrap.com [JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white -[JQuery-url]: https://jquery.com +[JQuery-url]: https://jquery.com diff --git a/CHANGELOG.md b/CHANGELOG.md index 1ece0c3..81213c8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,27 +2,28 @@ ## v1.1.2 -### Added or Changed +### Added or Changed (v1.1.2) + - Change license to Unlicense; releasing the project fully into the public domain - Add simplified project cover image - ## v1.1.1 -### Added or Changed -- Fixed back to top alignment (revert changes) +### Added or Changed (v1.1.1) +- Fixed back to top alignment (revert changes) ## v1.1.0 -### Added or Changed +### Added or Changed (v1.1.0) + - Fixed back to top link alignment deprecated tag, use CSS style instead - Added contrib.rocks to show top contributors - ## v1.0.0 -### Added or Changed +### Added or Changed (v1.0.0) + - Added this changelog :) - Fixed typos in both templates - Back to top links @@ -32,4 +33,4 @@ ### Removed -- Some packages/libraries from acknowledgements I no longer use \ No newline at end of file +- Some packages/libraries from acknowledgements I no longer use