Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Fix typo
  • Loading branch information
iwatakeshi authored Nov 17, 2019
1 parent e873096 commit d9a53fb
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,26 @@ This project is the spiritual successor of [gittar](https://github.com/lukeed/gi
```typescript
import { fetch, extract } = from 'gitly'

consle.log(await fetch('iwatakeshi/gitly'))
//=> ~/.gitly/github/iwatakeshi/gitly/master.tar.gz
console.log(await fetch('iwatakeshi/gitly'))
// -> ~/.gitly/github/iwatakeshi/gitly/master.tar.gz

consle.log(await fetch('iwatakeshi/gitly#v1.0.0'))
//=> ~/.gitly/github/iwatakeshi/gitly/v1.0.0.tar.gz
console.log(await fetch('iwatakeshi/gitly#v1.0.0'))
// -> ~/.gitly/github/iwatakeshi/gitly/v1.0.0.tar.gz

consle.log(await fetch('https://github.com/iwatakeshi/gitly'))
//=> ~/.gitly/github/iwatakeshi/gitly/master.tar.gz
console.log(await fetch('https://github.com/iwatakeshi/gitly'))
// -> ~/.gitly/github/iwatakeshi/gitly/master.tar.gz

consle.log(await fetch('gitlab:Rich-Harris/buble#v0.15.2'))
//=> ~/.gitly/gitlab/Rich-Harris/buble/v0.15.2.tar.gz
console.log(await fetch('gitlab:Rich-Harris/buble#v0.15.2'))
// -> ~/.gitly/gitlab/Rich-Harris/buble/v0.15.2.tar.gz

consle.log(await fetch('Rich-Harris/buble', { host: 'gitlab' }))
//=> ~/.gitly/gitlab/Rich-Harris/buble/master.tar.gz
console.log(await fetch('Rich-Harris/buble', { host: 'gitlab' }))
// -> ~/.gitly/gitlab/Rich-Harris/buble/master.tar.gz

const source = '...local file or repo pattern to the local file...'
const dest = '/path/to/foobar'

await extract(source, destination)
// -> /path/to/foobar
```

## Options
Expand Down

0 comments on commit d9a53fb

Please sign in to comment.