This is a template repository for a Typescript NPM package. It contains Typescript, ESLint, Jest and VSCode integrations.
- Click the "Use Template" button on Github to create your own repository from this template
- Locally clone your new remote Github repository
- Run
node setup.jswithin the repository directory, entering in some details.
If you found this delightful, feel free to sponsor me on GitHub 💕 or buy me a coffee ☕
Note: This template is approximately based off of verba. Feel free to take a look at that to see how this template can be expanded upon.
{{package-slogan}}
Badges like license type, current build status, and npm package version info can go here. Uncomment the HTML below within this README to show them.
Provide a quick overview of what your package does.
If it is a large package, put a "Getting Started" wiki page link here.
Briefly show what using your package looks like. Try to omit as much configuration as possible as your package wiki can detail that.
Mention where any usage examples are, either within the repository or externally hosted.
See ./contributing/development.md
If desired, briefly mention any donation links here. Here's Buy Me a Coffee as an example:
If you found this package delightful, feel free to buy me a coffee ✨