Skip to content

Commit fe9087c

Browse files
committed
other: Add Chanelog, Update Contribute, Add Blank ReadMe
1 parent 45cdcce commit fe9087c

File tree

2 files changed

+273
-0
lines changed

2 files changed

+273
-0
lines changed

CHANGELOG.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Changelog
2+
3+
## vX.X
4+
5+
### Added or Changed
6+
- ...
7+
8+
### Removed
9+
- ...
10+
## v0.1 beta
11+
12+
### Added or Changed
13+
- LICENSE
14+
- CHANGELOG
15+
- CONTRIBUTE
16+
- docs
17+
- Initial versions of the book chapters
18+
- 00-Front.md,
19+
- 00-Back.md,
20+
- ...
21+
- 99-references-and-resources
22+
- assets
23+
- images used in the documentation
24+
### Removed
25+
26+
- n/a

assets/BLANK_README.md

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

0 commit comments

Comments
 (0)