Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
qiushiyan committed May 23, 2024
1 parent ba61f1b commit 7a8120a
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,18 @@

Go port of [degit](https://github.com/rich-harris/degit).

Usage

```bash
degit user/repo#ref output-dir
```

This downloads the github repository `https://github.com/user/repo" at "ref", ref could be a branch, a tag or commit hash. If ref is empty, the main branch will be used. You can specify subdirectories and use Gitlab and Bitbucket repositories as well. degit also maintains a cache to save downloads and keep refs updated.

## Installation

```bash
brew tap qiushiyan/degit https://github.com/qiushiyan/degit
brew install qiushiyan/degit/degit

degit user/repo#ref output-dir
```

Downloads the github repository locally. You can specify subdirectories and use Gitlab and Bitbucket repositories as well. If the commit hash does not change, degit uses the cached version to save downloading again.

0 comments on commit 7a8120a

Please sign in to comment.