README: add build and test instructions

Author: DJunge-w

README.md

@@ -64,6 +64,98 @@ This is not just a simple school project that will be left out once the semester
 Therefore, this is a project that has already benefited and will continue to benefit multiple parties. We are really glad to work on a project that has such a long-lasting impact during this semester. Hope you’ve enjoyed our presentation and thank you for listening. 
 
 
+### Getting Started
+
+```bash
+# 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
+* For publishing to npm, use `yarn publish` (or `npm publish`)
+
+### 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).
+
+```bash
+# Build for browsers
+yarn esbuild-browser:dev
+yarn esbuild-browser:watch
+
+# Build the cli for node
+yarn esbuild-node:dev
+yarn esbuild-node:watch
+```
+
+You can generate a full clean build with `yarn build-all` (which uses both `tsc` and `esbuild`).
+
+* `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).
+* esbuild for the browser uses the IIFE (immediately-invoked function expression) format, which executes the bundled code on load (see also https://github.com/evanw/esbuild/issues/29)
+
+
+### Tests with Jest
+
+You can write [Jest tests](https://jestjs.io/docs/getting-started) [like this](https://github.com/metachris/typescript-boilerplate/blob/master/src/main.test.ts):
+
+```typescript
+import { greet } from './main'
+
+test('the data is peanut butter', () => {
+  expect(1).toBe(1)
+});
+
+test('greeting', () => {
+  expect(greet('Foo')).toBe('Hello Foo')
+});
+```
+
+Run the tests with `yarn test`, no separate compile step is necessary.
+
+* See also the [Jest documentation](https://jestjs.io/docs/getting-started).
+* The tests can be automatically run in CI (GitHub Actions, GitLab CI): [`.github/workflows/lint-and-test.yml`](https://github.com/metachris/typescript-boilerplate/blob/master/.github/workflows/lint-and-test.yml), [`.gitlab-ci.yml`](https://github.com/metachris/typescript-boilerplate/blob/master/.gitlab-ci.yml)
+* Take a look at other modern test runners such as [ava](https://github.com/avajs/ava), [uvu](https://github.com/lukeed/uvu) and [tape](https://github.com/substack/tape)
+
+### Documentation, published with CI
+
+You can auto-generate API documentation from the TypeScript source files using [TypeDoc](https://typedoc.org/guides/doccomments/). The generated documentation can be published to GitHub / GitLab pages through the CI.
+
+Generate the documentation, using `src/main.ts` as entrypoint (configured in package.json):
+
+```bash
+yarn docs
+```
+
+The resulting HTML is saved in `docs/`.
+
+You can publish the documentation through CI:
+* [GitHub pages](https://pages.github.com/): See [`.github/workflows/deploy-gh-pages.yml`](https://github.com/metachris/typescript-boilerplate/blob/master/.github/workflows/deploy-gh-pages.yml)
+* [GitLab pages](https://docs.gitlab.com/ee/user/project/pages/): [`.gitlab-ci.yml`](https://github.com/metachris/typescript-boilerplate/blob/master/.gitlab-ci.yml)
+
+This is the documentation for this boilerplate project: https://metachris.github.io/typescript-boilerplate/
+
+### References
+
+* **[TypeScript Boilerplate](https://github.com/metachris/typescript-boilerplate)**
+* [Blog post: Starting a TypeScript Project in 2021](https://www.metachris.com/2021/03/bootstrapping-a-typescript-node.js-project/)
+* [TypeScript Handbook](https://www.typescriptlang.org/docs/handbook/intro.html)
+* [tsconfig docs](https://www.typescriptlang.org/tsconfig)
+* [esbuild docs](https://esbuild.github.io/)
+* [typescript-eslint docs](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/README.md)
+* [Jest docs](https://jestjs.io/docs/getting-started)
+* [GitHub Actions](https://docs.github.com/en/actions), [GitLab CI](https://docs.gitlab.com/ee/ci/)
+
 
 ## Authors
 - Han Guo <alexiland@outlook.com>