@nordhealth/components 3.18.0 → 3.18.1-alpha.0

package/README.md

@@ -21,7 +21,7 @@ For detailed information on what docker is, what is does, how it works etc, plea
 Once docker is installed, run the following command in the components directory:
 
 ```sh
-npm run build:docker
+pnpm 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.
@@ -34,17 +34,17 @@ Once this is complete, you can use the commands below to run tests in a docker c
 
 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.
-- `npm run build` - Builds the project.
-- `npm test` - Run all tests once, including visual regression.
-- `INCLUDE_VISUAL_REGRESSION=false npm test` - Run all tests once, excluding visual regression.
-- `npm test -- [path/glob for test file]` - Run specific tests file. e.g. `npm test -- **/Button.test.ts`
-- `npm run test:watch` - Run all tests and watch for changes.
-- `npm run test:capture` - Updates screenshot snapshots.
+- `pnpm start` - Compile components, start watching for changes, start local development server on port 3333.
+- `pnpm build` - Builds the project.
+- `pnpm test` - Run all tests once, including visual regression.
+- `INCLUDE_VISUAL_REGRESSION=false pnpm test` - Run all tests once, excluding visual regression.
+- `pnpm test -- [path/glob for test file]` - Run specific tests file. e.g. `pnpm test -- **/Button.test.ts`
+- `pnpm test:watch` - Run all tests and watch for changes.
+- `pnpm test:capture` - Updates screenshot snapshots.
 
 ## Development server
 
-The local development server started by `npm start` serves a file located at `/packages/components/demo/index.html`. Any local changes or new components are available on this page, so this can be used as a testing ground when developing.
+The local development server started by `pnpm start` serves a file located at `/packages/components/demo/index.html`. Any local changes or new components are available on this page, so this can be used as a testing ground when developing.
 
 Component usage examples are available via the dev server using the URL structure `http://localhost:3333/[component]/[example]/` e.g. `/button/basic/`. This is mapped to the file path `/button/usage/basic.html`. These pages get reloaded on any change.
 
@@ -60,13 +60,13 @@ It is possible to change the theme used in an example via a query string e.g. `/
 ## To create a new component
 
 ```sh
-npm run scaffold [component-name]
+pnpm scaffold [component-name]
 ```
 
 e.g.
 
 ```sh
-npm run scaffold date-picker
+pnpm scaffold date-picker
 ```
 
 ## License