Skip to content

Commit 71be494

Browse files
committed
docs
1 parent c0c5386 commit 71be494

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ docs: $(SRC)
1919
nbdev_build_docs
2020
touch docs
2121

22-
release: pypi conda_release
22+
release: pypi
2323
nbdev_bump_version
2424

2525
conda_release:

‎README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,31 @@
77

88
## Install
99

10-
Either `pip install ghtop` or `conda install -c fastai ghtop`.
10+
`pip install ghtop`.
1111

1212
## How to use
1313

14-
Run `ghtop -h` to view the help. There are 4 views you can choose:
14+
Run `ghtop -h` to view the help. There are 4 views you can choose: `ghtop simple`, `ghtop tail`, `ghtop quad`, or `ghtop users`. Each are shown and described below.
1515

16-
### `ghtop simple`
16+
### ghtop simple
1717

1818
A simple dump to your console of all events as they happen.
1919

2020
<img src="https://user-images.githubusercontent.com/346999/101861674-79e7df80-3b25-11eb-92d3-f888843f4aa2.png" style="width:500px" width="500">
2121

22-
### `ghtop tail`
22+
### ghtop tail
2323

2424
Like `simple`, but removes most bots, and only includes releases, issues and PRs (open, close, and comment events). A summary of the frequency of push events is also shown at the bottom of the screen.
2525

2626
<img src="https://user-images.githubusercontent.com/346999/101861658-69376980-3b25-11eb-96ef-9d68f075abf7.png" style="width:700px" width="700">
2727

28-
### `ghtop quad`
28+
### ghtop quad
2929

3030
The same information as `tail`, but in a split window showing separately PRs, issues, pushes, and releases. This view does not remove bot activity.
3131

3232
<img src="https://user-images.githubusercontent.com/346999/101861560-2ecdcc80-3b25-11eb-9fba-25382b2df65f.png" style="width:900px" width="900">
3333

34-
### `ghtop users`
34+
### ghtop users
3535

3636
A summary of activity for the most active current users, including bots.
3737

‎docs/index.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,31 @@
77

88
## Install
99

10-
Either `pip install ghtop` or `conda install -c fastai ghtop`.
10+
`pip install ghtop`.
1111

1212
## How to use
1313

14-
Run `ghtop -h` to view the help. There are 4 views you can choose:
14+
Run `ghtop -h` to view the help. There are 4 views you can choose: `ghtop simple`, `ghtop tail`, `ghtop quad`, or `ghtop users`. Each are shown and described below.
1515

16-
### `ghtop simple`
16+
### ghtop simple
1717

1818
A simple dump to your console of all events as they happen.
1919

2020
<img src="https://user-images.githubusercontent.com/346999/101861674-79e7df80-3b25-11eb-92d3-f888843f4aa2.png" style="width:500px" width="500">
2121

22-
### `ghtop tail`
22+
### ghtop tail
2323

2424
Like `simple`, but removes most bots, and only includes releases, issues and PRs (open, close, and comment events). A summary of the frequency of push events is also shown at the bottom of the screen.
2525

2626
<img src="https://user-images.githubusercontent.com/346999/101861658-69376980-3b25-11eb-96ef-9d68f075abf7.png" style="width:700px" width="700">
2727

28-
### `ghtop quad`
28+
### ghtop quad
2929

3030
The same information as `tail`, but in a split window showing separately PRs, issues, pushes, and releases. This view does not remove bot activity.
3131

3232
<img src="https://user-images.githubusercontent.com/346999/101861560-2ecdcc80-3b25-11eb-9fba-25382b2df65f.png" style="width:900px" width="900">
3333

34-
### `ghtop users`
34+
### ghtop users
3535

3636
A summary of activity for the most active current users, including bots.
3737

0 commit comments

Comments
 (0)