Skip to content

Commit

Permalink
Add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
talex5 committed Sep 6, 2020
1 parent 1b0fd13 commit 3eb6236
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,17 @@ This renders as:
> If there is no activity, display a suitable message. If only one repository
> has activity, don't add a heading for it.
## Installation

Install [opam][] if you don't already have it and then:

```
git clone https://github.com/talex5/get-activity.git
cd get-activity
opam pin -n get-activity.dev .
opam depext -i get-activity
```

## Activity sources

At the moment, GitHub activity is the only source it queries.
Expand Down Expand Up @@ -53,3 +64,5 @@ Tip: if you want to be able to open the URLs it adds in a browser, you can use s
" gx to open URLs in Firefox
let g:netrw_browsex_viewer= "firefox"
```

[opam]: http://opam.ocaml.org/

0 comments on commit 3eb6236

Please sign in to comment.