Skip to content

Commit 5bef6d4

Browse files
committed
Update README
1 parent c31debf commit 5bef6d4

File tree

1 file changed

+62
-67
lines changed

1 file changed

+62
-67
lines changed

README.md

Lines changed: 62 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -13,37 +13,35 @@
1313

1414
</p>
1515

16-
## Install Good First Issues
16+
## 📦 Installation
1717

18-
Requires Python 3.9 or higher.
18+
> Requires **Python 3.9 or higher**.
1919
2020
```bash
21-
$ pip3 install good-first-issues --upgrade
21+
$ pip install good-first-issues --upgrade
2222
```
2323

2424
The CLI uses the alias `gfi` to run commands.
2525

2626
<img src="https://i.imgur.com/UM4e9vQ.png" width="800" />
2727

2828
## Contents
29-
30-
- [Install Good First Issues](#install-good-first-issues)
31-
- [Contents](#contents)
32-
- [Create GitHub Personal Access Token](#create-github-personal-access-token)
33-
- [Usage](#usage)
34-
- [Search for issues](#search-for-issues)
35-
- [Query all repos in an organization](#query-all-repos-in-an-organization)
36-
- [Query a single repo in an organization](#query-a-single-repo-in-an-organization)
37-
- [Query all repos in a user profile](#query-all-repos-in-a-user-profile)
38-
- [Query a single repo in a user profile.](#query-a-single-repo-in-a-user-profile)
39-
- [Search for Hacktoberfest approved issues](#search-for-hacktoberfest-approved-issues)
40-
- [Query all repos with topic `hacktoberfest`](#query-all-repos-with-topic-hacktoberfest)
29+
- [📦 Installation](#-installation)
30+
- [🔑 Create GitHub Personal Access Token](#-create-github-personal-access-token)
31+
- [🚀 Usage](#-usage)
32+
- [🏢 Query all repos in an organization](#-query-all-repos-in-an-organization)
33+
- [📦 Query a single repo in an organization](#-query-a-single-repo-in-an-organization)
34+
- [👨‍💻 Query all repos in a user profile](#-query-all-repos-in-a-user-profile)
35+
- [📦 Query a single repo in a user profile.](#-query-a-single-repo-in-a-user-profile)
36+
- [🐙 Query all repos with topic `hacktoberfest`](#-query-all-repos-with-topic-hacktoberfest)
4137
- [Query all repos with topic 'hacktoberfest' in an organization or in a user profile](#query-all-repos-with-topic-hacktoberfest-in-an-organization-or-in-a-user-profile)
42-
- [Changing output limits](#changing-output-limits)
43-
- [Viewing issues on browser](#viewing-issues-on-browser)
44-
- [Contributing](#contributing)
38+
- [📏 Search for issues within a certain period](#-search-for-issues-within-a-certain-period)
39+
- [⚖️ Limit output](#️-limit-output)
40+
- [🌐 View issues on browser](#-view-issues-on-browser)
41+
- [👀 Show the CLI version](#-show-the-cli-version)
42+
- [🔨 Contributing](#-contributing)
4543

46-
### Create GitHub Personal Access Token
44+
### 🔑 Create GitHub Personal Access Token
4745

4846
The CLI requires GitHub Personal Access Token to make requests to the GitHub API.
4947

@@ -63,15 +61,11 @@ Token is stored locally on `/home/<username>/.gfi/good-first-issues` file.
6361

6462
Store the token with the name `GFITOKEN` in your environment.
6563

66-
## Usage
64+
## 🚀 Usage
6765

6866
GitHub provides API to fetch user and organization data. [Personal Access Token](#create-github-personal-access-token) is required for authentication and data fetching.
6967

70-
### Search for issues
71-
72-
To look for issues, use the `gfi search` command.
73-
74-
#### Query all repos in an organization
68+
### 🏢 Query all repos in an organization
7569

7670
```bash
7771
$ gfi search "rust-lang"
@@ -82,7 +76,7 @@ $ gfi search "rust-lang"
8276
8377
</details>
8478

85-
#### Query a single repo in an organization
79+
### 📦 Query a single repo in an organization
8680

8781
```bash
8882
$ gfi search "facebook" --repo "jest"
@@ -93,7 +87,7 @@ $ gfi search "facebook" --repo "jest"
9387
9488
</details>
9589

96-
#### Query all repos in a user profile
90+
### 👨‍💻 Query all repos in a user profile
9791

9892
```bash
9993
$ gfi search "yankeexe" --user
@@ -104,7 +98,7 @@ $ gfi search "yankeexe" --user
10498
10599
</details>
106100

107-
#### Query a single repo in a user profile.
101+
### 📦 Query a single repo in a user profile.
108102

109103
`--user` flag not required here.
110104

@@ -117,17 +111,50 @@ $ gfi search "yankeexe" --repo "good-first-issues"
117111
118112
</details>
119113

120-
### Search for Hacktoberfest approved issues
121114

122-
#### Query all repos with topic `hacktoberfest`
115+
### 🐙 Query all repos with topic `hacktoberfest`
123116

124117
```bash
125118
$ gfi search --hacktoberfest
126119

127120
$ gfi search -hf
128121
```
129122

130-
### Search for issues within a certain period
123+
> <details><summary><strong>Demo</strong></summary>
124+
> <img src = "https://i.imgur.com/6Ch5BFG.gif" width="700" alt="demo of timezone cli search" />
125+
126+
</details>
127+
128+
#### Query all repos with topic 'hacktoberfest' in an organization or in a user profile
129+
130+
Query all repos with topic 'hacktoberfest' in an organization.
131+
132+
```bash
133+
$ gfi search "facebook" --hacktoberfest
134+
```
135+
136+
```bash
137+
$ gfi search "yankeexe" --user -hf
138+
```
139+
140+
> <details><summary><strong>Demo</strong></summary>
141+
> <img src = "https://i.imgur.com/Kj6lEMN.gif" width="700" alt="demo of timezone cli search" />
142+
143+
</details>
144+
145+
Query all repos with topic 'hacktoberfest' in a user profile.
146+
`--user` flag not required here.
147+
148+
```bash
149+
$ gfi search "yankeexe" --hacktoberfest
150+
```
151+
152+
> <details><summary><strong>Demo</strong></summary>
153+
> <img src = "https://i.imgur.com/vrgr8ju.gif" width="700" alt="demo of timezone cli search" />
154+
155+
</details>
156+
157+
### 📏 Search for issues within a certain period
131158

132159
By default, no period is set and users are shown whatever data is fetched from the GitHub API.
133160

@@ -161,38 +188,7 @@ $ gfi search "yankeexe" --user --repo "good-first-issues" -p "600 days"
161188

162189
```
163190

164-
165-
> <details><summary><strong>Demo</strong></summary>
166-
> <img src = "https://i.imgur.com/6Ch5BFG.gif" width="700" alt="demo of timezone cli search" />
167-
168-
</details>
169-
170-
#### Query all repos with topic 'hacktoberfest' in an organization or in a user profile
171-
172-
Query all repos with topic 'hacktoberfest' in an organization.
173-
174-
```bash
175-
$ gfi search "facebook" --hacktoberfest
176-
```
177-
178-
> <details><summary><strong>Demo</strong></summary>
179-
> <img src = "https://i.imgur.com/Kj6lEMN.gif" width="700" alt="demo of timezone cli search" />
180-
181-
</details>
182-
183-
Query all repos with topic 'hacktoberfest' in a user profile.
184-
`--user` flag not required here.
185-
186-
```bash
187-
$ gfi search "yankeexe" --hacktoberfest
188-
```
189-
190-
> <details><summary><strong>Demo</strong></summary>
191-
> <img src = "https://i.imgur.com/vrgr8ju.gif" width="700" alt="demo of timezone cli search" />
192-
193-
</details>
194-
195-
### Changing output limits
191+
### ⚖️ Limit output
196192

197193
The output is limited to display 10 issues by default. Use `--limit` flag to set the number of issues for output or `--all` for no limits.
198194

@@ -213,7 +209,7 @@ View all issues found.
213209
$ gfi search "rust-lang" --all
214210
```
215211

216-
### Viewing issues on browser
212+
### 🌐 View issues on browser
217213

218214
It's hard to navigate through all the issues when you have the `--all` flag enabled, you can view the issues on your browser with ease using the `--web` flag.
219215

@@ -226,13 +222,12 @@ $ gfi search "facebook" --all --web
226222
227223
</details>
228224

229-
### Show the CLI version
225+
### 👀 Show the CLI version
230226

231227
```bash
232228
$ gfi version
233229
```
234230

235-
236-
## Contributing
231+
## 🔨 Contributing
237232

238233
For guidance on setting up a development environment and how to make a contribution to `good-first-issues`, see the [contributing guidelines](https://github.com/yankeexe/good-first-issues/blob/master/CONTRIBUTING.md).

0 commit comments

Comments
 (0)