diff --git a/README.md b/README.md index 812e8b0..a4ef43f 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ And all this with almost no effort! ![React UiZoo 1](https://i.imgur.com/1VIerCJ.gif "React UiZoo 1") -We use JSDoc parsing from your current components to showcase them, with all of their possible properties, examples, and descriptions. +We use JSDoc/PropTypes parsing from your current components to showcase them, with all of their possible properties, examples, and descriptions. This tool can be used for developing, for Product Managers to know what is possible, for UX to see what we have so far, and it can be a playground for co-operation between all of the above. ![React UiZoo 3](https://imgur.com/f3B2TDj.gif) @@ -108,12 +108,24 @@ The tests package is isolated and located inside the /tests folder. The target of the tests is to run locally before committing changes and to be a sanity indicator that everything is okay. Tests are written in Protractor with Karma and they cover the project from end-to-end. +In the uizoo-app package (the local app helper module), the tests sits next to what they are testing. Those are written in Jest. + ### Run the tests once To perform the tests once, run: ``` npm test ``` +To run uizoo-app tests, run: +``` +cd packages/uizoo-app +npm test +``` +or for watching +``` +npm run test:w +``` + ### Develop tests To add tests, use the following steps - diff --git a/package.json b/package.json index 960f6a9..f9bb399 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "uizoo", - "version": "1.2.2", + "version": "1.3.0", "description": "Dynamic React Component Library", "scripts": { "start": "npm run gulp:w",