From 22b2e63a9d55935e8e03b8554de87d9e7dff0d69 Mon Sep 17 00:00:00 2001 From: Sunil Pai Date: Fri, 19 Jan 2024 00:24:32 +0530 Subject: [PATCH] Update README.md to correct options passed to `downloadTemplate()` The docs claim to accept options that aren't actually accepted (per https://github.com/unjs/giget/blob/83eb734bb6df993958023e19a363d93d60568248/src/giget.ts#L12-L25), this patch removes the fields not mentioned in the type --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index 4eb0c22..ffb16f4 100644 --- a/README.md +++ b/README.md @@ -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.