From ab7d1981b9e690e8be194f3a4f81e322e885bad0 Mon Sep 17 00:00:00 2001 From: John de Stigter Date: Fri, 9 Oct 2020 09:28:43 -0600 Subject: [PATCH] fix: Typos in README, proper env variables for prePublish command. --- README.md | 6 ++++-- package.json | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e4e0444..83e42da 100644 --- a/README.md +++ b/README.md @@ -19,9 +19,9 @@ Clone or fork this repository and run: #: npm test ``` -Running `npm install` will install both the dependencies in of project as well as those of the example project in `./examples`. +Running `npm install` will install both the dependencies of this project as well as those of the example project in `./examples`. -Running `npm test` will: +Running `CI=true && NODE_ENV=production npm test` will: 1. Build the project 2. `cd` into the project folder and @@ -29,6 +29,8 @@ Running `npm test` will: 4. Build the project (`npm run build`) 5. Perform the example end-to-end test. +You can also start up the example ReactJS project in development mode running at localhost:3000 and just run `npm test` in the root of the project. + The example test configuration can be found in [`./examples/xstate-marionettist-example/src/apps/auth/auth.e2e.ts`](examples/xstate-marionettist-example/src/apps/auth/auth.e2e.ts) ## Installation and project implementation diff --git a/package.json b/package.json index 7e059bd..337288d 100644 --- a/package.json +++ b/package.json @@ -51,7 +51,7 @@ "test": "npm run build && cd examples/xstate-marionettist-example && npm run e2e", "build:declaration": "tsc --build ./tsconfig.dec.json", "prepare": "cd examples/xstate-marionettist-example && npm install", - "prepublishOnly": "npm test" + "prepublishOnly": "CI=true NODE_ENV=production npm test" }, "files": [ "dist"