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] 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
@@ -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