Skip to content

Commit

Permalink
[ci skip] Update installation instructions in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yi-jiayu committed Feb 8, 2019
1 parent 0c2c695 commit af65700
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,32 @@ $ tree -L 3 $GITPATH

## Installation

`git` will make any executable prefixed with `git-` on your `$PATH` available as a `git` subcommand, so you will be able to run `git-get` as `git get` once it is on your `$PATH`.

### Binary downloads

Download a precompiled binary for the latest release for your system from the [Releases page](https://github.com/yi-jiayu/git-get/releases) and put it on your `$PATH`.

### Homebrew

Users on MacOS can use Homebrew:

```
brew install yi-jiayu/tap/git-get
```

### From source

With a working Go toolchain:

```
go build -o ~/bin/git-get
```
Replace `~/bin` with any directory on your `$PATH`.

`git` will make any executable prefixed with `git-` on your `$PATH` available as a `git` subcommand, so you will be able to run `git-get` as `git get`.
Replace `~/bin` with any directory on your `$PATH`.

## URL support
## Git URL support

- [x] GitHub
- [x] GitLab
- [ ] Generic
- [x] Generic

0 comments on commit af65700

Please sign in to comment.