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