Skip to content

Commit

Permalink
docs: correct downloadTemplate options (#144)
Browse files Browse the repository at this point in the history
  • Loading branch information
threepointone committed Mar 6, 2024
1 parent 58e20ab commit 2398346
Showing 1 changed file with 0 additions and 3 deletions.
3 changes: 0 additions & 3 deletions README.md
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

0 comments on commit 2398346

Please sign in to comment.