cleanup

README.md

@@ -2,61 +2,80 @@
 
 [![Build and test status](https://github.com/metachris/typescript-boilerplate/workflows/Lint%20and%20test/badge.svg)](https://github.com/metachris/micropython-ctl/actions?query=workflow%3A%22Build+and+test%22)
 
-Get started quickly and right-footed
+TypeScript project boilerplate with modern tooling, for Node.js and browser. Get started quickly and right-footed 🚀
 
-TypeScript project boilerplate with modern tooling, targetting for Node.js and browser.
-
-* [TypeScript](https://www.typescriptlang.org/) 4
-* Optionally [esbuild](https://esbuild.github.io/) - to bundle for browsers and Node.js
+* [TypeScript 4](https://www.typescriptlang.org/)
+* Optionally [esbuild](https://esbuild.github.io/) to bundle for browsers (and Node.js)
 * Linting with [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint) ([tslint](https://palantir.github.io/tslint/) is deprecated)
 * Testing with [Jest](https://jestjs.io/docs/getting-started) (and [ts-jest](https://www.npmjs.com/package/ts-jest))
 * Publishing to npm
 * Continuous integration ([GitHub Actions](https://docs.github.com/en/actions) / [GitLab CI](https://docs.gitlab.com/ee/ci/))
 * Automatic API documentation with [TypeDoc](https://typedoc.org/guides/doccomments/)
 
-See also the introduction blog post: [Starting a TypeScript Project in 2021](https://www.metachris.com/2021/03/bootstrapping-a-typescript-node.js-project/).
+See also the introduction blog post: **[Starting a TypeScript Project in 2021](https://www.metachris.com/2021/03/bootstrapping-a-typescript-node.js-project/)**.
 
 
 ## Getting Started
 
-* Clone the repository (you can also click "Use this template")
-* Edit `package.json` and `tsconfig.json` to your liking
-* Now you can run `yarn run`, `yarn lint`, `yarn test`, `yarn build` and `yarn ts-node <filename>`.
+```bash
+# Clone the repository (you can also click "Use this template")
+git clone https://github.com/metachris/typescript-boilerplate.git your_project_name
+cd your_project_name
+
+# Edit `package.json` and `tsconfig.json` to your liking
+...
+
+# Install dependencies
+yarn install
+
+# Now you can run various yarn commands:
+yarn cli
+yarn lint
+yarn test
+yarn build-all
+yarn ts-node <filename>
+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`)
 
 ## esbuild
 
-You can use [esbuild](https://esbuild.github.io/) to bundle for browsers (and Node.js if you want).
-`esbuild` is an extremely fast bundler that supports a [large part of the TypeScript syntax](https://esbuild.github.io/content-types/#typescript).
+[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).
 
 ```bash
-# Install esbuild
-yarn add -D esbuild
-
-# Compile and bundle, with cli as entrypoint
-./node_modules/.bin/esbuild src/cli.ts --bundle --platform=node --outfile=dist/esbuild/cli.js
-
 # Build for browsers
-./node_modules/.bin/esbuild src/browser.ts --bundle --outfile=dist/esbuild/browser.js
+yarn esbuild-browser:dev
+yarn esbuild-browser:watch
+
+# Build the cli for node
+yarn esbuild-node:dev
+yarn esbuild-node:watch
 ```
 
-You can build everything with `yarn build`. Read more about the esbuild setup [here](https://www.metachris.com/2021/04/starting-a-typescript-project-in-2021/#esbuild).
+You can generate a full build with both `tsc` and `esbuild` with `yarn build-all`.
+
+* The `package.json` includes `scripts` for various esbuild commands: [see here](https://github.com/metachris/typescript-boilerplate/blob/master/package.json#L23)
+* `esbuild` has a `--global-name=xyz` flag, to store the exports from the entry point in a global variable. See also the [esbuild "Global name" docs](https://esbuild.github.io/api/#global-name).
+* Read more about the esbuild setup [here](https://www.metachris.com/2021/04/starting-a-typescript-project-in-2021/#esbuild).
+
+## Documentation, published with CI
 
-This `package.json` includes `scripts` for various esbuild commands: [see here](https://github.com/metachris/typescript-boilerplate/blob/master/package.json#L23)
+You can auto-generate API documentation from the TyoeScript source files using [TypeDoc](https://typedoc.org/guides/doccomments/). The generated documentation can be published to GitHub / GitLab pages through the CI:
 
-## Documentation, published to GitHub or GitLab pages
+```bash
+yarn docs
+```
 
-You can auto-generate API documentation from the TyoeScript source files using [typedoc](https://typedoc.org/guides/doccomments/). The generated documentation can be published to GitHub / GitLab pages through the CI:
+The resulting HTML is saved in `docs/`. It uses `src/main.ts` as entrypoint (configured in package.json).
 
-* Install [typedoc](https://typedoc.org/guides/doccomments/): `yarn add -D typedoc`
-* Add `docs` script to `package.json`: `"docs": "typedoc --entryPoints src/main.ts"`
-* You can now generate the documentation with `yarn docs`. The resulting HTML is saved in `docs/`.
-* Publish to pages through CI:
-  * [GitHub pages](https://pages.github.com/): uncomment content of `.github/workflows/deploy-gh-pages.yml` and enable pages in GitHub repo settings
-  * [GitLab pages](https://docs.gitlab.com/ee/user/project/pages/): uncomment deploy task in `.gitlab-ci.yml`
+You can publish the documentation through CI:
+* [GitHub pages](https://pages.github.com/): uncomment content of `.github/workflows/deploy-gh-pages.yml` and enable pages in GitHub repo settings
+* [GitLab pages](https://docs.gitlab.com/ee/user/project/pages/): uncomment deploy task in `.gitlab-ci.yml`
 
-For example the documentation for this project: https://metachris.github.io/typescript-boilerplate/
+This is the documentation for this boilerplate project: https://metachris.github.io/typescript-boilerplate/
 
 ## References
 

package.json

@@ -5,6 +5,7 @@
   "author": "Chris Hager <[email protected]>",
   "repository": "https://github.com/metachris/typescript-boilerplate",
   "license": "MIT",
+  "keywords": ["typescript", "boilerplate", "esbuild"],
   "main": "./dist/tsc/main.js",
   "types": "./dist/tsc/main.d.ts",
   "browser": "./dist/esbuild/browser.js",