Skip to content

Commit 612a9f9

Browse files
committed
πŸ“– DOC: update readme
1 parent 3086600 commit 612a9f9

File tree

1 file changed

+51
-20
lines changed

1 file changed

+51
-20
lines changed

β€Žreadme.mdβ€Ž

Lines changed: 51 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<div align="center">
44
<h1>⚑️ github-interact-cli<br>
5-
<img alt="version: 3.1.0" src="https://img.shields.io/badge/version-v3.1.0-green">
5+
<img alt="version: 3.2.0" src="https://img.shields.io/badge/version-v3.2.0-green">
66
<img alt="license: MIT" src="https://img.shields.io/badge/license-MIT-green">
77
</h1>
88
</div>
@@ -12,6 +12,7 @@
1212
## πŸ‘‰ Features
1313

1414
- πŸ“¦ Create a new repo
15+
- ♻️ Delete your existing repo
1516
- πŸš€ Get all public repos of any GitHub User
1617
- ⚠️ Open issue in any repo.
1718
- βœ‰οΈ Get public email of any GitHub user
@@ -39,9 +40,9 @@ github
3940

4041
CLI will start running. It will ask you to add a **Personal Access Token** & your **GitHub Username**. If you don't know what Personal Access Token is & how to create one, check this [awesome guide](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) by GitHub.
4142

42-
`!Note:` Be sure to give the token _repo_ & _admin:repo_hook_ access.
43+
`!Note:` Be sure to give the token _repo_, _admin:repo_hook_ & _delete repo_ scopes .
4344

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

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

@@ -59,13 +60,43 @@ github
5960

6061
You will get this menu. πŸ”₯
6162

62-
<img alt="menu" src="https://i.imgur.com/kvLbE9T.png">
63+
<img alt="menu" src="https://i.imgur.com/ccwTAbs.png">
6364

6465
Enter <kbd>1</kbd> to Create a GitHub Repo. Then answer the next questions.
6566

66-
<img alt="done" src="https://i.imgur.com/LsSQeoL.png">
67+
<img alt="done" src="https://i.imgur.com/bRPNnat.png">
6768

68-
Taa daa! The repo has been created. You can [check](https://github.com/msaaddev/git-testing-repo) it! πŸ₯‚
69+
Taa daa! The repo has been created. You can [check](https://github.com/msaaddev/git-test-repo) it! πŸ₯‚
70+
71+
### ♻️ Delete your Existing Repo
72+
73+
Type the following in the terminal to run the CLI.
74+
75+
```
76+
github
77+
```
78+
79+
You will get this menu. πŸ”₯
80+
81+
<img alt="menu" src="https://i.imgur.com/ccwTAbs.png">
82+
83+
Enter <kbd>2</kbd> to Create a GitHub Repo. Then enter the name of the repo you want to delete.
84+
85+
<img alt="done" src="https://i.imgur.com/fdpmK2O.png">
86+
87+
Taa daa! The repo has been deleted. πŸ™ŒπŸ»
88+
89+
`! Note:` Be sure to give your personal access token _delete repo_ scope. If you don't know how to edit your current token, follow these steps.
90+
91+
- Open your GitHub account settings
92+
- Select **Developer settings** from the left sidebar
93+
- Click on **Personal access tokens**
94+
- You will see a list of personal access tokens. Select the token you created earlier for github-interact-cli.
95+
- Scroll down the scope list and select **delete_repo**
96+
- Then scroll at the bottom & select **Update token**
97+
98+
99+
<img alt="steps of editing personal access token" src="https://i.imgur.com/2s3lOJV.gif">
69100

70101
### πŸš€ Get All Repos
71102

@@ -77,11 +108,11 @@ github
77108

78109
You will get this menu. πŸ”₯
79110

80-
<img alt="menu" src="https://i.imgur.com/kvLbE9T.png">
111+
<img alt="menu" src="https://i.imgur.com/ccwTAbs.png">
81112

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.
113+
Enter <kbd>3</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.
83114

84-
<img alt="enter username" src="https://i.imgur.com/n8sLwe3.png">
115+
<img alt="enter username" src="https://i.imgur.com/K0eW1yR.png">
85116

86117
Press <kbd>Enter</kbd>. And there you have it, folks! πŸ”₯
87118

@@ -97,13 +128,13 @@ github
97128

98129
You will get this menu. πŸ”₯
99130

100-
<img alt="menu" src="https://i.imgur.com/kvLbE9T.png">
131+
<img alt="menu" src="https://i.imgur.com/ccwTAbs.png">
101132

102-
Enter <kbd>3</kbd> to Create a GitHub Issue. Then answer the next questions.
133+
Enter <kbd>4</kbd> to Create a GitHub Issue. Then answer the next questions.
103134

104-
<img alt="done" src="https://i.imgur.com/x2SCUT6.png">
135+
<img alt="done" src="https://i.imgur.com/bAp9IK5.png">
105136

106-
[Click here](https://github.com/msaaddev/vidly/issues/8) to check the issue I just created in the screenshot.
137+
[Click here](https://github.com/msaaddev/vidly/issues/9) to check the issue I just created in the screenshot.
107138

108139
### βœ‰οΈ Get Public Email
109140

@@ -115,11 +146,11 @@ github
115146

116147
You will get this menu. πŸ”₯
117148

118-
<img alt="menu" src="https://i.imgur.com/kvLbE9T.png">
149+
<img alt="menu" src="https://i.imgur.com/ccwTAbs.png">
119150

120-
Enter <kbd>4</kbd> to get public email of the GitHub user. Then answer the next questions.
151+
Enter <kbd>5</kbd> to get public email of the GitHub user. Then enter the username of the GitHub user.
121152

122-
<img alt="done" src="https://i.imgur.com/qeqvJ0Y.png">
153+
<img alt="done" src="https://i.imgur.com/huGK5nv.png">
123154

124155
### ⭐️Get Stargazers
125156

@@ -131,11 +162,11 @@ github
131162

132163
You will get this menu. πŸ”₯
133164

134-
<img alt="menu" src="https://i.imgur.com/kvLbE9T.png">
165+
<img alt="menu" src="https://i.imgur.com/ccwTAbs.png">
135166

136-
Enter <kbd>5</kbd> to get total number of stargazers of any GitHub repos. Then answer the next questions.
167+
Enter <kbd>6</kbd> to get total number of stargazers of any GitHub repos. Then answer the next questions.
137168

138-
<img alt="done" src="https://i.imgur.com/QzqIS9x.png">
169+
<img alt="done" src="https://i.imgur.com/TynjyHI.png">
139170

140171
## πŸš€ FEATURE REQUEST
141172

@@ -147,7 +178,7 @@ Use the [Issues](https://github.com/msaaddev/github-interact-cli/issues) section
147178

148179
## πŸ‘¨πŸ»β€πŸ’» AUTHOR
149180

150-
πŸ™‹πŸ»β€β™‚οΈ Hola! I am Saad, an undergrad Computer Science student. Follow me at
181+
πŸ™‹πŸ»β€β™‚οΈ Hola! I am Saad, an undergrad Computer Science student. I developed this CLI to automate the repetitive ridiculous amount of things we have to do in GitHub. You can follow me at
151182

152183
- [Twitter](https://twitter.com/msaaddev)
153184
- [Facebook](https://www.facebook.com/msaaddev)

0 commit comments

Comments
Β (0)