Skip to content

Commit

Permalink
Clarify README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arbourd committed Apr 3, 2024
1 parent 42af2b6 commit 5dab029
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# git-get

`git-get` clones repositories to your `GETPATH` in the same fashion as `go get`.
`git get` clones repositories to your `GETPATH` in the same fashion as `go get`.

## Usage

Get a repository to `~/src`
Get a repository to the default `GETPATH` `~/src`

```console
$ git get github.com/arbourd/git-get
Expand All @@ -21,12 +21,18 @@ Set a custom `GETPATH` with `git config`.

```console
$ git config --global get.path "~/dev"

$ git get github.com/arbourd/git-get
~/dev/github.com/arbourd/git-get
```

Set a custom `GETPATH` with the environmental variable `$GETPATH`.

```shell
export GETPATH=~/dev
```console
$ export GETPATH=~/dev

$ git get github.com/arbourd/git-get
~/dev/github.com/arbourd/git-get
```

### Using SSH as the default
Expand Down

0 comments on commit 5dab029

Please sign in to comment.