docs: correct `downloadTemplate` options - Githubissues

unjs / giget

✨ Download templates and git repositories with pleasure!

MIT License

484 stars 39 forks source link

docs: correct `downloadTemplate` options #144

Closed threepointone closed 8 months ago

threepointone commented 10 months ago

❓ Type of change

[x] 📖 Documentation (updates to the documentation, readme, or JSdoc annotations)
[ ] 🐞 Bug fix (a non-breaking change that fixes an issue)
[ ] 👌 Enhancement (improving an existing functionality like performance)
[ ] ✨ New feature (a non-breaking change that adds functionality)
[ ] 🧹 Chore (updates to the build process or auxiliary tools and libraries)
[ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

The README claims 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

📝 Checklist

[ ] I have linked an issue or discussion.
[x] I have updated the documentation accordingly.