Skip to content

Commit 64124d2

Browse files
committed
📖 DOC: installation & usage
1 parent 6c6b25a commit 64124d2

1 file changed

Lines changed: 33 additions & 1 deletion

File tree

readme.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,43 @@
77
</h1>
88
</div>
99

10-
github-interact-cli lets you use GitHub features right inside your termina;.
10+
`github-interact-cli` lets you use GitHub right inside your termina;.
1111

1212
## 👉 Features
1313

1414
- 📦 Create a new repo
1515
- ⚠️ Open issue in any repo.
1616
- ✉️ Get public email of any GitHub user
1717
- ⭐️Get stargazers of any GitHub repo
18+
19+
## 🎩 INSTALLATION
20+
21+
If you are windows user, run your command prompt/terminal as administrator. If you are macOS user, add `sudo` before the following command.
22+
23+
```
24+
npm i -g github-interact-cli
25+
```
26+
27+
<div align="center">
28+
<img src="https://i.imgur.com/ClFFvhH.gif">
29+
</div>
30+
31+
## 🔥 HOW TO USE
32+
33+
Type the following in the terminal to run the CLI.
34+
35+
```
36+
github
37+
```
38+
39+
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.
40+
41+
`!Note:` Be sure to give the token *repo* & *admin:repo_hook* access.
42+
43+
<img src="https://i.imgur.com/El9gYcp.png">
44+
45+
Once you are done, exit the CLI so that configurations can be saved & used again.
46+
47+
<img src="https://i.imgur.com/fVdgewD.png">
48+
49+
`! Note:` This is one time thing. You will not have to do it again every time you will run the CLI.

0 commit comments

Comments
 (0)