readme

Author: jph00

.gitignore

@@ -1,3 +1,4 @@
+docs
 _nbdev.py
 log.txt
 *.bak

Makefile

@@ -1,9 +1,8 @@
 .ONESHELL:
 SHELL := /bin/bash
-SRC = $(wildcard ./*.ipynb)
+SRC = $(wildcard nbs/*.ipynb)
 
-all:
-	echo not using nbdev at the moment
+all: ghtop docs
 
 ghtop: $(SRC)
 	nbdev_build_lib

README.md

@@ -1,41 +1,42 @@
 # ghtop
 > See what's happening on GitHub in real time (also helpful if you need to use up your API quota as quickly as possible).
 
+
 `ghtop` provides a number of views of all current public activity from all users across the entire GitHub platform. (Note that GitHub delays all events by five minutes.)
 
-<img style="width:850px" width="850" src="https://user-images.githubusercontent.com/56260/101270865-3f033780-3732-11eb-8dcc-97caf7cc58e6.png">
+<img width="850" src="https://user-images.githubusercontent.com/56260/101270865-3f033780-3732-11eb-8dcc-97caf7cc58e6.png" style="max-width: 850px">
 
 ## Install
 
-`pip install ghtop`.
+Either `pip install ghtop` or `conda install -c fastai ghtop`.
 
 ## How to use
 
-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.
+Run `ghtop -h` to view the help. There are 4 views you can choose:
 
-### ghtop simple
+### `ghtop simple`
 
 A simple dump to your console of all events as they happen.
 
-<img src="https://user-images.githubusercontent.com/346999/101861674-79e7df80-3b25-11eb-92d3-f888843f4aa2.png" style="width:500px" width="500">
+<img src="https://user-images.githubusercontent.com/346999/101861674-79e7df80-3b25-11eb-92d3-f888843f4aa2.png" width="500" style="max-width: 500px">
 
-### ghtop tail
+### `ghtop tail`
 
 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.
 
-<img src="https://user-images.githubusercontent.com/346999/101861658-69376980-3b25-11eb-96ef-9d68f075abf7.png" style="width:700px" width="700">
+<img src="https://user-images.githubusercontent.com/346999/101861658-69376980-3b25-11eb-96ef-9d68f075abf7.png" width="700" style="max-width: 700px">
 
-### ghtop quad
+### `ghtop quad`
 
 The same information as `tail`, but in a split window showing separately PRs, issues, pushes, and releases. This view does not remove bot activity.
 
-<img src="https://user-images.githubusercontent.com/346999/101861560-2ecdcc80-3b25-11eb-9fba-25382b2df65f.png" style="width:900px" width="900">
+<img src="https://user-images.githubusercontent.com/346999/101861560-2ecdcc80-3b25-11eb-9fba-25382b2df65f.png" width="900" style="max-width: 900px">
 
-### ghtop users
+### `ghtop users`
 
 A summary of activity for the most active current users, including bots.
 
-<img src="https://user-images.githubusercontent.com/346999/101861612-4b6a0480-3b25-11eb-8124-19bb2434c27e.png" style="width:500px" width="500">
+<img src="https://user-images.githubusercontent.com/346999/101861612-4b6a0480-3b25-11eb-8124-19bb2434c27e.png" width="500" style="max-width: 500px">
 
 ----