Skip to content

Commit 1433c52

Browse files
committed
updated README with usage
1 parent 7b7d15f commit 1433c52

1 file changed

Lines changed: 24 additions & 1 deletion

File tree

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
11
# Github Stats
22

3-
`gstats` is a CLI tool that provides comprehensive statistics and information about GitHub repositories and users.
3+
`gstats` is a A CLI tool for getting information on github repositories and users.
4+
5+
## Usage
6+
7+
```sh
8+
gstats
9+
10+
common args
11+
--verbose: shows more information
12+
13+
commands
14+
help: shows what commands do
15+
16+
downloads: shows download counts of github releases
17+
[user] [repo]
18+
followers: shows the followers of a user
19+
[user]
20+
following: shows the users a user is following
21+
[user]
22+
repo: shows information about a repository
23+
[user] [repo]
24+
user: shows information about a user
25+
[user]
26+
```

0 commit comments

Comments
 (0)