Skip to content

Commit eb6941b

Browse files
authored
updated README.md
1 parent 17e0dd7 commit eb6941b

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,24 @@
22

33
A Web-App that lists 30 of the most popular repositories of a language (overall also). It also lets you battle between any two GitHub users.
44

5+
## How to use?
6+
7+
Open [Github Battle](https://github-battlereact.netlify.com/) in any browser of your choice. After the landing page pops on the screen, under the "Popular" category, you can see different header sections for most commonly used programming languages like for Javascript, Python, Java, Ruby etc. The default option among them will be set to all, but you can hover over any of them and choose one, which will redirect you to the default github repository page of the selected one. Moreover, the more exciting part of [Github-Battle](https://github-battlereact.netlify.com/) is the [Battle](https://github-battlereact.netlify.com/battle) section which can be located just beside the "Popular" category on the top left corner of the screen. User(s) can enter their Github usernames of any choice under the player section and then click on submit. Upon submit, the two entered names will automatically be assigned to their default github avatars and then battle starts (for invalid github username, invalid avatars will be assigned). Fraction of seconds later, the winner name is displayed on the screen along with name, score, address, address, followers, following as well as the total number of repositories in their accounts.
8+
59
### Features :
6-
1. Lists 30 of the most popular GitHub repositories in a language.
7-
2. Battle any two GitHub users.
10+
```
11+
1. Lists 30 of the most popular GitHub repositories in a language.
12+
2. Battle any two GitHub users.
13+
```
814

915
### Technologies Used :
10-
* React-JS
16+
```
17+
* React-JS
1118
* React Router
1219
* React Hooks
1320
* GitHub's API
1421
* Netlify.com (for hosting)
22+
```
1523

1624
### How to Run Locally :
1725

@@ -44,3 +52,10 @@ A Web-App that lists 30 of the most popular repositories of a language (overall
4452
</td>
4553
</tr>
4654
</table>
55+
56+
## Contributing
57+
58+
Want to help? Awesome! We are always thrilled to receive pull requests, and do our best to process them as fast as possible. Not sure if that typo is worth a pull request? Do it! We will appreciate it.
59+
60+
If your pull request is not accepted on the first try, don't be discouraged! If there's a problem with the implementation, hopefully you received feedback on what to improve.
61+

0 commit comments

Comments
 (0)