diff --git a/README.md b/README.md index 9fc8d46..af569af 100644 --- a/README.md +++ b/README.md @@ -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