Skip to content

Commit 459093f

Browse files
committed
added BLANK_README
1 parent 1ad6360 commit 459093f

File tree

1 file changed

+230
-0
lines changed

1 file changed

+230
-0
lines changed

BLANK_README.md

+230
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,230 @@
1+
<div id="top"></div>
2+
<!--
3+
*** Thanks for checking out the Best-README-Template. If you have a suggestion
4+
*** that would make this better, please fork the repo and create a pull request
5+
*** or simply open an issue with the tag "enhancement".
6+
*** Don't forget to give the project a star!
7+
*** Thanks again! Now go create something AMAZING! :D
8+
-->
9+
10+
11+
12+
<!-- PROJECT SHIELDS -->
13+
<!--
14+
*** I'm using markdown "reference style" links for readability.
15+
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
16+
*** See the bottom of this document for the declaration of the reference variables
17+
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
18+
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
19+
-->
20+
[![Contributors][contributors-shield]][contributors-url]
21+
[![Forks][forks-shield]][forks-url]
22+
[![Stargazers][stars-shield]][stars-url]
23+
[![Issues][issues-shield]][issues-url]
24+
[![MIT License][license-shield]][license-url]
25+
[![LinkedIn][linkedin-shield]][linkedin-url]
26+
27+
28+
29+
<!-- PROJECT LOGO -->
30+
<br />
31+
<div align="center">
32+
<a href="https://github.com/github_username/repo_name">
33+
<img src="images/logo.png" alt="Logo" width="80" height="80">
34+
</a>
35+
36+
<h3 align="center">project_title</h3>
37+
38+
<p align="center">
39+
project_description
40+
<br />
41+
<a href="https://github.com/github_username/repo_name"><strong>Explore the docs »</strong></a>
42+
<br />
43+
<br />
44+
<a href="https://github.com/github_username/repo_name">View Demo</a>
45+
·
46+
<a href="https://github.com/github_username/repo_name/issues">Report Bug</a>
47+
·
48+
<a href="https://github.com/github_username/repo_name/issues">Request Feature</a>
49+
</p>
50+
</div>
51+
52+
53+
54+
<!-- TABLE OF CONTENTS -->
55+
<details>
56+
<summary>Table of Contents</summary>
57+
<ol>
58+
<li>
59+
<a href="#about-the-project">About The Project</a>
60+
<ul>
61+
<li><a href="#built-with">Built With</a></li>
62+
</ul>
63+
</li>
64+
<li>
65+
<a href="#getting-started">Getting Started</a>
66+
<ul>
67+
<li><a href="#prerequisites">Prerequisites</a></li>
68+
<li><a href="#installation">Installation</a></li>
69+
</ul>
70+
</li>
71+
<li><a href="#usage">Usage</a></li>
72+
<li><a href="#roadmap">Roadmap</a></li>
73+
<li><a href="#contributing">Contributing</a></li>
74+
<li><a href="#license">License</a></li>
75+
<li><a href="#contact">Contact</a></li>
76+
<li><a href="#acknowledgments">Acknowledgments</a></li>
77+
</ol>
78+
</details>
79+
80+
81+
82+
<!-- ABOUT THE PROJECT -->
83+
## About The Project
84+
85+
[![Product Name Screen Shot][product-screenshot]](https://example.com)
86+
87+
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`
88+
89+
<p align="right">(<a href="#top">back to top</a>)</p>
90+
91+
92+
93+
### Built With
94+
95+
* [Next.js](https://nextjs.org/)
96+
* [React.js](https://reactjs.org/)
97+
* [Vue.js](https://vuejs.org/)
98+
* [Angular](https://angular.io/)
99+
* [Svelte](https://svelte.dev/)
100+
* [Laravel](https://laravel.com)
101+
* [Bootstrap](https://getbootstrap.com)
102+
* [JQuery](https://jquery.com)
103+
104+
<p align="right">(<a href="#top">back to top</a>)</p>
105+
106+
107+
108+
<!-- GETTING STARTED -->
109+
## Getting Started
110+
111+
This is an example of how you may give instructions on setting up your project locally.
112+
To get a local copy up and running follow these simple example steps.
113+
114+
### Prerequisites
115+
116+
This is an example of how to list things you need to use the software and how to install them.
117+
* npm
118+
```sh
119+
npm install npm@latest -g
120+
```
121+
122+
### Installation
123+
124+
1. Get a free API Key at [https://example.com](https://example.com)
125+
2. Clone the repo
126+
```sh
127+
git clone https://github.com/github_username/repo_name.git
128+
```
129+
3. Install NPM packages
130+
```sh
131+
npm install
132+
```
133+
4. Enter your API in `config.js`
134+
```js
135+
const API_KEY = 'ENTER YOUR API';
136+
```
137+
138+
<p align="right">(<a href="#top">back to top</a>)</p>
139+
140+
141+
142+
<!-- USAGE EXAMPLES -->
143+
## Usage
144+
145+
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.
146+
147+
_For more examples, please refer to the [Documentation](https://example.com)_
148+
149+
<p align="right">(<a href="#top">back to top</a>)</p>
150+
151+
152+
153+
<!-- ROADMAP -->
154+
## Roadmap
155+
156+
- [ ] Feature 1
157+
- [ ] Feature 2
158+
- [ ] Feature 3
159+
- [ ] Nested Feature
160+
161+
See the [open issues](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues).
162+
163+
<p align="right">(<a href="#top">back to top</a>)</p>
164+
165+
166+
167+
<!-- CONTRIBUTING -->
168+
## Contributing
169+
170+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
171+
172+
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".
173+
Don't forget to give the project a star! Thanks again!
174+
175+
1. Fork the Project
176+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
177+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
178+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
179+
5. Open a Pull Request
180+
181+
<p align="right">(<a href="#top">back to top</a>)</p>
182+
183+
184+
185+
<!-- LICENSE -->
186+
## License
187+
188+
Distributed under the MIT License. See `LICENSE.txt` for more information.
189+
190+
<p align="right">(<a href="#top">back to top</a>)</p>
191+
192+
193+
194+
<!-- CONTACT -->
195+
## Contact
196+
197+
Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com
198+
199+
Project Link: [https://github.com/github_username/repo_name](https://github.com/github_username/repo_name)
200+
201+
<p align="right">(<a href="#top">back to top</a>)</p>
202+
203+
204+
205+
<!-- ACKNOWLEDGMENTS -->
206+
## Acknowledgments
207+
208+
* []()
209+
* []()
210+
* []()
211+
212+
<p align="right">(<a href="#top">back to top</a>)</p>
213+
214+
215+
216+
<!-- MARKDOWN LINKS & IMAGES -->
217+
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
218+
[contributors-shield]: https://img.shields.io/github/contributors/github_username/repo_name.svg?style=for-the-badge
219+
[contributors-url]: https://github.com/github_username/repo_name/graphs/contributors
220+
[forks-shield]: https://img.shields.io/github/forks/github_username/repo_name.svg?style=for-the-badge
221+
[forks-url]: https://github.com/github_username/repo_name/network/members
222+
[stars-shield]: https://img.shields.io/github/stars/github_username/repo_name.svg?style=for-the-badge
223+
[stars-url]: https://github.com/github_username/repo_name/stargazers
224+
[issues-shield]: https://img.shields.io/github/issues/github_username/repo_name.svg?style=for-the-badge
225+
[issues-url]: https://github.com/github_username/repo_name/issues
226+
[license-shield]: https://img.shields.io/github/license/github_username/repo_name.svg?style=for-the-badge
227+
[license-url]: https://github.com/github_username/repo_name/blob/master/LICENSE.txt
228+
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
229+
[linkedin-url]: https://linkedin.com/in/linkedin_username
230+
[product-screenshot]: images/screenshot.png

0 commit comments

Comments
 (0)