diff --git a/README.md b/README.md index 4a32c15a54..e55cf6e3f2 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,8 @@ vue init username/repo my-project Where `username/repo` is the GitHub repo shorthand for your fork. +The shorthand repo notation is passed to [download-git-repo](https://github.com/flipxfx/download-git-repo) so you can also use things like `bitbucket:username/repo` for a Bitbucket repo and `username/repo#branch` for tags or branches. + You can also create your own template from scratch: - A template repo **must** have a `template` directory that holds the template files. diff --git a/bin/vue-init b/bin/vue-init index cb085b7c2f..efaa48d63e 100755 --- a/bin/vue-init +++ b/bin/vue-init @@ -2,7 +2,7 @@ var Khaos = require('khaos-patched') var metadata = require('read-metadata') -var download = require('download-github-repo') +var download = require('download-git-repo') var program = require('commander') var exists = require('fs').existsSync var join = require('path').join diff --git a/package.json b/package.json index d128b24688..3412a438be 100644 --- a/package.json +++ b/package.json @@ -28,7 +28,7 @@ "dependencies": { "chalk": "^1.1.1", "commander": "^2.9.0", - "download-github-repo": "^0.1.3", + "download-git-repo": "^0.0.1", "khaos-patched": "^0.9.3", "read-metadata": "^1.0.0", "request": "^2.67.0",