Skip to content

Update README.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
KoleboshinD wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
197 changes: 2 additions & 195 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,196 +1,3 @@
<a id="readme-top"></a>

[comment]: # (There is some text that we don't want to be visible...)
[//]: # (There is some text that we don't want to be visible...)

<!-- PROJECT LOGO -->
![Product Name Screen Shot](https://raw.githubusercontent.com/othneildrew/Best-README-Template/main/images/screenshot.png)

<!-- TABLE OF CONTENTS -->

<details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgments">Acknowledgments</a></li>
</ol>
</details>


<!-- ABOUT THE PROJECT -->
## About The Project

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:

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!

<p align="right"> <a href="#readme-top">back to top</a> </p>

### 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.

|Name |URL |Logo |
|------:|:-------:|--------:|
|React |https://reactjs.org |<img src="https://reactjs.org/logo-og.png" width="50" /> |
|Vue.js |https://vuejs.org |<img src="https://vuejs.org/images/logo.png" width="50" />|
|Angular |https://angular.io |<img src="https://angular.io/assets/images/logos/angular/angular.png" width="50" /> |
|Svelte |https://svelte.dev |<img src="https://svelte.dev/svelte-logo-horizontal.svg" width="50" /> |

<p align="right"> <a href="#readme-top">back to top</a> </p>

<!-- GETTING STARTED -->
## 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.

<p align="right"> <a href="#readme-top">back to top</a> </p>

### Prerequisites

This is an example of how to list things you need to use the software and how to install them.

<p align="right"> <a href="#readme-top">back to top</a> </p>

### 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.*

1. Get a free API Key at 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
```

<p align="right"> <a href="#readme-top">back to top</a> </p>

<!-- USAGE EXAMPLES -->
## 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.

<p align="right"> <a href="#readme-top">back to top</a> </p>

<!-- ROADMAP -->
## 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

todo: add some text...

<p align="right"> <a href="#readme-top">back to top</a> </p>

<!-- CONTRIBUTING -->
## 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**.

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`)
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

### Top contributors:

[![Top contributors image](https://contrib.rocks/image?repo=othneildrew/Best-README-Template)](https://github.com/othneildrew/Best-README-Template/graphs/contributors)
<p align="right"> <a href="#readme-top">back to top</a> </p>

<!-- LICENSE -->
## License

Distributed under the Unlicense License.

<p align="right"> <a href="#readme-top">back to top</a> </p>

<!-- CONTACT -->
## Contact

Your Name

<p align="right"> <a href="#readme-top">back to top</a> </p>

<!-- ACKNOWLEDGMENTS -->
## 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!

* [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)

<p align="right"> <a href="#readme-top">back to top</a> </p>

## Quotes

> «Simplicity is the ultimate sophistication» — Leonardo da Vinci.

<p align="right"> <a href="#readme-top">back to top</a> </p>

## Author’s links

* <https://github.com/pragmatic-programmer-education>
* [Github homepage](https://github.com/pragmatic-programmer-education)
* [Github homepage](https://github.com/pragmatic-programmer-education "Click here to navigate to author's homepage")

<p align="right"> <a href="#readme-top">back to top</a> </p>



#About the project

first project