diff --git a/README.md b/README.md index 656d7d0..e03eeff 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,16 @@ yarn esbuild-browser * Take a look at all the scripts in [`package.json`](https://github.com/metachris/typescript-boilerplate/blob/master/package.json) * For publishing to npm, use `yarn publish` (or `npm publish`) +You may use this boilerplate as static [charmix archetype](https://github.com/vitonsky/charmix) + +```bash +# Install archetype +charmix add -t git https://github.com/metachris/typescript-boilerplate.git + +# Generate project +charmix use -d ./projectDirectory typescript-boilerplate +``` + ## esbuild [esbuild](https://esbuild.github.io/) is an extremely fast bundler that supports a [large part of the TypeScript syntax](https://esbuild.github.io/content-types/#typescript). This project uses it to bundle for browsers (and Node.js if you want). diff --git a/archetype.json b/archetype.json new file mode 100644 index 0000000..b9c4dc7 --- /dev/null +++ b/archetype.json @@ -0,0 +1,8 @@ +{ + "name": "typescript-boilerplate", + "type": "staticTemplate", + "files": { + "include": "./*", + "exclude": ["./archetype.json"] + } +}