Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: correct downloadTemplate options #144

Merged
merged 1 commit into from Mar 6, 2024
Merged

docs: correct downloadTemplate options #144

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 0 additions & 3 deletions README.md
View file
Open in desktop
Expand Up @@ -143,9 +143,6 @@ const { source, dir } = await downloadTemplate("github:unjs/template");
- `options`: (object) Options are usually inferred from the input string. You can customize them.
- `dir`: (string) Destination directory to clone to. If not provided, `user-name` will be used relative to the current directory.
- `provider`: (string) Either `github`, `gitlab`, `bitbucket` or `sourcehut`. The default is `github`.
- `repo`: (string) Name of the repository in the format of `{username}/{reponame}`.
- `ref`: (string) Git ref (branch or commit or tag). The default value is `main`.
- `subdir`: (string) Directory of the repo to clone from. The default value is none.
- `force`: (boolean) Extract to the existing dir even if already exists.
- `forceClean`: (boolean) ⚠️ Clean up any existing directory or file before cloning.
- `offline`: (boolean) Do not attempt to download and use the cached version.
Expand Down