@nordhealth/components 1.0.1 → 1.2.0

package/README.md

@@ -4,6 +4,34 @@
 
 The component package found from `packages/components` is built with [Lit](https://lit.dev/), a library for building Web Components. The component source code is written in TypeScript, with stylesheets written in CSS.
 
+## Initial setup
+
+We use [Docker](https://www.docker.com/) to run automated tests in a consistent, stable environment across platforms. Docker requires one-time installation and setup.
+
+On mac, if you use [brew](https://brew.sh/), then docker can be installed with the the following command:
+
+```sh
+brew install --cask docker
+```
+
+Alternatively, you can download docker directly from here: https://docs.docker.com/get-docker/
+
+For detailed information on what docker is, what is does, how it works etc, please refer to their documentation.
+
+Once docker is installed, run the following command in the components directory:
+
+```sh
+npm run build:docker
+```
+
+This will create, install, and build all the necessary parts for running tests inside a docker container. The result of this process is cached, and will be used whenever tests are run.
+
+**NOTE:** This should also be run whenever `package.json` dependencies change.
+
+Once this is complete, you can use the commands below to run tests in a docker container.
+
+## Commands
+
 The following are the most commonly used commands during development:
 
 - `npm start` - Compile components, start watching for changes, start local development server on port 3333.
@@ -34,4 +62,4 @@ See license in LICENSE.md
 
 ## Copyright
 
-Copyright © 2022 Nordhealth Ltd
+Copyright © 2022 Nordhealth Ltd.