Skip to content

Commit 0b5b6b0

Browse files
Merge pull request #867 from SusheelThapa/enhance-readme
Added badge and code snippet to the Readme
2 parents 60ec88a + e973d4c commit 0b5b6b0

File tree

1 file changed

+67
-25
lines changed

1 file changed

+67
-25
lines changed

README.md

+67-25
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,81 @@
1-
# Welcome to the JavaScript Mini Projects Repository!
2-
### Description
3-
"Welcome to our JavaScript Playground on GitHub! 🚀 Explore a diverse range of projects that showcase the capabilities of JavaScript. Whether you're just starting your coding journey or have been in the field for a while, there's something here for everyone. It's not about fancy titles; it's about the joy of coding in JavaScript. Dive in, explore the code, and let the love for coding and learning flow! Thank you for contributing to this collaborative space. Happy coding! 🌟"
1+
# <p align="center">Welcome to the JavaScript Mini Projects</p>
2+
3+
<p align="center">
4+
<a href="https://github.com/thinkswell/javascript-mini-projects/blob/master/LICENSE" target="blank">
5+
<img src="https://img.shields.io/github/license/thinkswell/javascript-mini-projects?style=for-the-badge&logo=appveyor" alt="License" />
6+
</a>
7+
<a href="https://github.com/thinkswell/javascript-mini-projects/fork" target="blank">
8+
<img src="https://img.shields.io/github/forks/thinkswell/javascript-mini-projects?style=for-the-badge&logo=appveyor" alt="Forks"/>
9+
</a>
10+
<a href="https://github.com/thinkswell/javascript-mini-projects/stargazers" target="blank">
11+
<img src="https://img.shields.io/github/stars/thinkswell/javascript-mini-projects?style=for-the-badge&logo=appveyor" alt="Star"/>
12+
</a>
13+
<a href="https://github.com/thinkswell/javascript-mini-projects/issues" target="blank">
14+
<img src="https://img.shields.io/github/issues/thinkswell/javascript-mini-projects.svg?style=for-the-badge&logo=appveyor" alt="Issue"/>
15+
</a>
16+
<a href="https://github.com/thinkswell/javascript-mini-projects/pulls" target="blank">
17+
<img src=" https://img.shields.io/github/issues-pr/thinkswell/javascript-mini-projects.svg?style=for-the-badge&logo=appveyor" alt="Open Pull Request"/>
18+
</a>
19+
</p>
20+
21+
## Description 🚀
22+
23+
Explore a diverse range of projects that showcase the capabilities of JavaScript. Whether you're just starting your coding journey or have been in the field for a while, there's something here for everyone. It's not about fancy titles; it's about the joy of coding in JavaScript. Dive in, explore the code, and let the love for coding and learning flow! Thank you for contributing to this collaborative space. Happy coding! 🌟"
24+
25+
## How to Contribute
426

5-
### How to Contribute
627
Make some awesome projects, put them in your directory and create a pull request. and DONE ✅
728

829
### Steps to Raise and get your PR Merged successfully.
9-
👉 Fork this repository
1030

11-
👉 Clone the repository into your local system
31+
1. Fork this repository
1232

13-
👉 Create a branch ```projectname-username```, e.g. - ```git checkout -b ChatApp-thinkswell```
33+
2. Clone the repository into your local system
1434

15-
👉 Add your projects in the respective directory (if exist otherwise create one), the name of directory should be your ```ProjectName/USERNAME```, e.g. - ChatApp/thinkswell
35+
```bash
36+
git clone https://github.com/<username>/javascript-mini-projects.git
37+
```
1638

17-
👉 **Add ```One project``` at a time**
39+
3. Create a branch `projectname-username`, e.g. - `git checkout -b ChatApp-thinkswell`
1840

19-
👉 **Add & commit**, use ```git add -A```, than ```git commit -m "Your commit message about project"```
41+
```bash
42+
git checkout -b ChatApp-thinkswell
43+
```
2044

21-
👉 **Push changes to GitHub**, e.g. - ```git push origin ChatApp-thinkswell```
45+
4. Add your projects in the respective directory (if exist otherwise create one), the name of directory should be your `ProjectName/USERNAME`.
2246

23-
👉 **Click** on `Create a Pull Request`.
47+
Examples: `ChatApp/thinkswell`
2448

25-
👉 Attach some **SCREENSHOTS/GIF** or **link of your working project** in the description _**❗Important❗**_.
49+
5. **Add `One project` at a time**
2650

27-
👉 **Submit** the PR.
51+
6. **Add & commit**
2852

29-
👉 **Leave a ⭐ to the repo and `FOLLOW` me if you liked the project.**
53+
```bash
54+
git add -A
55+
git commit -m "Your commit message about project"
56+
```
3057

31-
***
58+
7. **Push changes to GitHub**,
59+
60+
```bash
61+
git push origin ChatApp-thinkswell
62+
```
63+
64+
8. **Click** on `Create a Pull Request`.
65+
66+
9. Attach some **SCREENSHOTS/GIF** or **link of your working project** in the description _**❗Important❗**_.
67+
68+
10. **Submit** the PR.
69+
70+
11. **Leave a ⭐ to the repo and `FOLLOW` me if you liked the project.**
71+
72+
---
3273

3374
### What You Can Contribute
75+
3476
We welcome contributions from the community to enhance and expand our collection of mini JavaScript projects. Here are several ways you can contribute:
3577

36-
👉 **Add New Projects**
78+
👉 **Add New Projects**
3779

3880
Do you have a creative JavaScript project that you think would be a great addition to our collection? Submit your project!
3981

@@ -47,9 +89,10 @@ Have an idea for a new project? Create a new issue by clicking on the `New Issue
4789

4890
We're happy to merge awesome portfolio to this repository!
4991

50-
***
92+
---
93+
94+
## Usage
5195

52-
### Usage
5396
This repository contains a collection of mini JavaScript projects, each designed to demonstrate a specific concept or feature. Here's how you can use these projects:
5497

5598
👉 **Choose a project**
@@ -66,19 +109,18 @@ Change directory to the specific project you want to explore.
66109

67110
👉 **Open index.html or index.js in your browser**
68111

69-
Most projects include an index.html or index.js file. Open this file in your web browser to interact with the project.
112+
Most projects include an index.html or index.js file. Open this file in your web browser to interact with the project.
70113

71114
👉 **Explore and interact**
72115

73116
Have fun with the project!
74117

75-
***
118+
---
76119

77-
### Disclaimer
120+
## Disclaimer
78121

79122
We have a strong commitment to genuine open source contributions and, therefore, do not tolerate plagiarized source code. If our maintainers discover that any Pull Requests (PRs) fail to adhere to this Terms and Conditions, they will be categorized as spam and subsequently closed.
80123

81-
***
124+
---
82125

83-
# Hurray! Now you are a part of the open source community 🚀🚀🚀
84-
126+
## <p align="center">Hurray! Now you are a part of the open source community 🚀🚀🚀</p>

0 commit comments

Comments
 (0)