Skip to content

Commit 3f8928d

Browse files
committed
📖 DOC: updated
1 parent 821334b commit 3f8928d

File tree

1 file changed

+41
-18
lines changed

1 file changed

+41
-18
lines changed

readme.md

+41-18
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
<div align="center">
44
<h1>⚡️ github-interact-cli<br>
5-
<img src="https://img.shields.io/badge/version-v3.0.0-green">
6-
<img src="https://img.shields.io/badge/license-MIT-green">
5+
<img alt="version: 3.1.0" src="https://img.shields.io/badge/version-v3.1.0-green">
6+
<img alt="license: MIT" src="https://img.shields.io/badge/license-MIT-green">
77
</h1>
88
</div>
99

@@ -12,6 +12,7 @@
1212
## 👉 Features
1313

1414
- 📦 Create a new repo
15+
- 🚀 Get all public repos of any GitHub User
1516
- ⚠️ Open issue in any repo.
1617
- ✉️ Get public email of any GitHub user
1718
- ⭐️Get stargazers of any GitHub repo
@@ -25,7 +26,7 @@ npm i -g github-interact-cli
2526
```
2627

2728
<div align="center">
28-
<img src="https://i.imgur.com/ClFFvhH.gif">
29+
<img alt="installation" src="https://i.imgur.com/ClFFvhH.gif">
2930
</div>
3031

3132
## 🏗 SETUP
@@ -40,11 +41,11 @@ CLI will start running. It will ask you to add a **Personal Access Token** & you
4041

4142
`!Note:` Be sure to give the token _repo_ & _admin:repo_hook_ access.
4243

43-
<img src="https://i.imgur.com/El9gYcp.png">
44+
<img alt="personal access token configurations" src="https://i.imgur.com/El9gYcp.png">
4445

4546
Once you are done, exit the CLI so that configurations can be saved & used again.
4647

47-
<img src="https://i.imgur.com/fVdgewD.png">
48+
<img alt="done" src="https://i.imgur.com/fVdgewD.png">
4849

4950
`! Note:` This is one time thing. You will not have to do it again every time you run the CLI.
5051

@@ -58,13 +59,33 @@ github
5859

5960
You will get this menu. 🔥
6061

61-
<img src="https://i.imgur.com/z9I199e.png">
62+
<img alt="menu" src="https://i.imgur.com/kvLbE9T.png">
6263

63-
Enter `1` to Create a GitHub Repo. Then answer the next questions.
64+
Enter <kbd>1</kbd> to Create a GitHub Repo. Then answer the next questions.
6465

65-
<img src="https://i.imgur.com/fpv4MBS.gif">
66+
<img alt="done" src="https://i.imgur.com/LsSQeoL.png">
6667

67-
Taa daa! Your repo has been created. 🥂
68+
Taa daa! The repo has been created. You can [check](https://github.com/msaaddev/git-testing-repo) it! 🥂
69+
70+
### 🚀 Get All Repos
71+
72+
Type the following in the terminal to run the CLI.
73+
74+
```
75+
github
76+
```
77+
78+
You will get this menu. 🔥
79+
80+
<img alt="menu" src="https://i.imgur.com/kvLbE9T.png">
81+
82+
Enter <kbd>2</kbd> to get all GitHub Public Repos of the any GitHub user. Next enter the username of the GitHub user you want to see the repos of.
83+
84+
<img alt="enter username" src="https://i.imgur.com/n8sLwe3.png">
85+
86+
Press <kbd>Enter</kbd>. And there you have it, folks! 🔥
87+
88+
<img alt="done" src="https://i.imgur.com/kID3qMm.png">
6889

6990
### ⚠️ Open Issue
7091

@@ -76,11 +97,13 @@ github
7697

7798
You will get this menu. 🔥
7899

79-
<img src="https://i.imgur.com/z9I199e.png">
100+
<img alt="menu" src="https://i.imgur.com/kvLbE9T.png">
101+
102+
Enter <kbd>3</kbd> to Create a GitHub Issue. Then answer the next questions.
80103

81-
Enter `2` to Create a GitHub Repo. Then answer the next questions.
104+
<img alt="done" src="https://i.imgur.com/x2SCUT6.png">
82105

83-
<img src="https://i.imgur.com/ZP6TzQc.png">
106+
[Click here](https://github.com/msaaddev/vidly/issues/8) to check the issue I just created in the screenshot.
84107

85108
### ✉️ Get Public Email
86109

@@ -92,11 +115,11 @@ github
92115

93116
You will get this menu. 🔥
94117

95-
<img src="https://i.imgur.com/z9I199e.png">
118+
<img alt="menu" src="https://i.imgur.com/kvLbE9T.png">
96119

97-
Enter `3` to Create a GitHub Repo. Then answer the next questions.
120+
Enter <kbd>4</kbd> to get public email of the GitHub user. Then answer the next questions.
98121

99-
<img src="https://i.imgur.com/ajXz5RE.png">
122+
<img alt="done" src="https://i.imgur.com/qeqvJ0Y.png">
100123

101124
### ⭐️Get Stargazers
102125

@@ -108,11 +131,11 @@ github
108131

109132
You will get this menu. 🔥
110133

111-
<img src="https://i.imgur.com/z9I199e.png">
134+
<img alt="menu" src="https://i.imgur.com/kvLbE9T.png">
112135

113-
Enter `4` to Create a GitHub Repo. Then answer the next questions.
136+
Enter <kbd>5</kbd> to get total number of stargazers of any GitHub repos. Then answer the next questions.
114137

115-
<img src="https://i.imgur.com/E70a4Xv.png">
138+
<img alt="done" src="https://i.imgur.com/QzqIS9x.png">
116139

117140
## 🚀 FEATURE REQUEST
118141

0 commit comments

Comments
 (0)