Skip to content

Commit

Permalink
updating Readme and releasing version 1.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Noam Elboim committed Nov 13, 2017
1 parent 3925f88 commit 2b069fb
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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 -

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit 2b069fb

Please sign in to comment.