Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dlvhdr authored Apr 1, 2022
1 parent f190301 commit e976af1
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# gh-dash

A `gh` cli extension to display a dashboard with pull requests or issues by filters you care about.
✨ A GitHub (`gh`) CLI extension to display a dashboard with **pull requests** and **issues** by filters you care about.

![demo](https://raw.githubusercontent.com/dlvhdr/gh-prs/main/demo.gif)
<img width="800px" src="https://raw.githubusercontent.com/dlvhdr/gh-prs/main/demo.gif" />

## Installation

Installation requires a minimum version (2.0.0) of the the Github CLI to support extensions.

1. Install the `gh cli` - see the [installation/upgrade instructions](https://github.com/cli/cli#installation)
1. Install the `gh` CLI - see the [installation](https://github.com/cli/cli#installation)

2. Install this extension:

```sh
gh extension install dlvhdr/gh-dash
```
```sh
gh extension install dlvhdr/gh-dash
```

3. To get the icons to render properly you should download and install a Nerd font from https://www.nerdfonts.com/.
Then, select that font as your font for the terminal.
Expand Down Expand Up @@ -74,7 +74,7 @@ defaults:
width: 60
```
Adding PR or issue section is as easy as adding to the list of `prSections` or `issueSections` appropriately:
Adding a PR or issue section is as easy as adding to the list of `prSections` or `issueSections` respectively:
- title - shown in the TUI
- filters - how the repo's PRs should be filtered - these are plain [github filters](https://docs.github.com/en/search-github/searching-on-github/searching-issues-and-pull-requests)
Expand Down

0 comments on commit e976af1

Please sign in to comment.