diff --git a/README.md b/README.md
index fd4fd7d..6844916 100644
--- a/README.md
+++ b/README.md
@@ -1,37 +1,51 @@
-
+
- Good First Issues
-Find good first issues right from your CLI!
+
+ Good First Issues
+
-
-
-
-
+ Find good first issues right from your CLI!
+
+
+
+
+
+
## π¦ Installation
-> Requires **Python 3.9 or higher**.
+Requires **Python 3.9 or higher**.
```bash
$ pip install good-first-issues --upgrade
# Using uvx
-
$ uvx --from good-first-issues gfi
```
The CLI uses the alias `gfi` to run commands.
+### β Verify Installation
+
+After installation, you can verify that `gfi` is installed correctly by checking the version:
+
+```bash
+$ gfi version
+```
+
+This should display the installed version of good-first-issues.
+
## Contents
-- [π¦ Installation](#-installation)
- - [π Create GitHub Personal Access Token](#-create-github-personal-access-token)
+
+- [π¦ Installation](#-installation)
+- [π Create GitHub Personal Access Token](#-create-github-personal-access-token)
- [π Usage](#-usage)
- [π’ Query all repos in an organization](#-query-all-repos-in-an-organization)
- [π¦ Query a single repo in an organization](#-query-a-single-repo-in-an-organization)
@@ -51,100 +65,70 @@ The CLI requires GitHub Personal Access Token to make requests to the GitHub API
> Get [GitHub Fine-grained Personal Access Token](https://github.com/settings/tokens?type=beta)
-You can add a Description to your token, select "Public Repositories (read-only)" and selectΒ _Generate token_.
-
-**Provide token to CLI:**
-
-```bash
-$ gfi config
-```
+You can add a Description to your token, select "Public Repositories (read-only)" and select _Generate token_.
-Token is stored locally on `/home//.gfi/good-first-issues` file.
+When you run the CLI for the first time, you'll be prompted for the GitHub Personal Access Token.
-**Token in environment variable:**
-
-Store the token with the name `GFITOKEN` in your environment.
+The token is stored locally in `~/.gfi/good-first-issues` file.
## π Usage
-GitHub provides API to fetch user and organization data. [Personal Access Token](#create-github-personal-access-token) is required for authentication and data fetching.
-
### π’ Query all repos in an organization
```bash
-$ gfi search "rust-lang"
+$ gfi search "kubernetes"
```
-> Demo
->
-
-
+>
+>
+> Demo
+>
+>
+>
+>
+>
### π¦ Query a single repo in an organization
```bash
-$ gfi search "facebook" --repo "jest"
+$ gfi search "rust-lang" --repo "rust"
```
-> Demo
->
-
-
-
### π¨βπ» Query all repos in a user profile
```bash
$ gfi search "yankeexe" --user
```
-> Demo
->
-
-
-
### π¦ Query a single repo in a user profile
-`--user` flag not required here.
-
```bash
-$ gfi search "yankeexe" --repo "good-first-issues"
+$ gfi search "yankeexe" --user --repo "good-first-issues"
```
-> Demo
->
-
-
-
-
### π Query all repos with topic `hacktoberfest`
```bash
-$ gfi search --hacktoberfest
-
$ gfi search -hf
-
-$ gfi search -hf --period "30 days"
-
-$ gfi search -hf --limit 10 --period "48 hours"
```
-> Demo
->
+#### Query all repos with topic 'hacktoberfest' in an organization or in a user profile
-
+```bash
+# Query for an organization
+$ gfi search "do-community" -hf
+# Query for a user profile
+$ gfi search "yankeexe" -hf --user
+```
### π Search for issues within a certain period
-By default, no period is set and users are shown whatever data is fetched from the GitHub API.
+By default, the issues are filtered within 1 day. You can provide filter period using `--period` flag.
-To filter good first issues within a certain period, use the following commands:
+Pass period in minutes, hours or days.
```bash
-
-# Query all organization repos
-$ gfi search "rust-lang" -p "30 hours"
-
# Query a specific repo in an organization
$ gfi search "rust-lang" --repo "rust" -p "30 mins"
@@ -161,11 +145,8 @@ $ gfi search "yankeexe" --user --repo "good-first-issues" -p "600 days"
```bash
# Example Usage:
--period 1 m,min,mins,minutes
-
--period 2 h,hr,hour,hours,hrs
-
--period 3 d,day,days
-
```
### βοΈ Limit output
@@ -178,10 +159,14 @@ Limit the issues to 12
$ gfi search "facebook" --limit 12
```
-> Demo
->
-
-
+>
+>
+> Demo
+>
+>
+>
+>
+>
View all issues found.
@@ -197,10 +182,14 @@ It's hard to navigate through all the issues when you have the `--all` flag enab
$ gfi search "facebook" --all --web
```
-> Demo
->
-
-
+>
+>
+> Demo
+>
+>
+>
+>
+>
### π Show the CLI version