Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xudafeng committed Aug 21, 2016
1 parent fcd0ba1 commit 7d6b1e8
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,18 @@

> uitest framework for Node.js based on Macaca
## installation
## Installation

```shell
$ npm i uitest --save-dev
```

## Sample

[uitest-sample](//github.com/xudafeng/uitest-sample)

## Usage

You should configure your entry HTML by including `uitest-mocha-shim.js`.

Here is an example `test.html`
Expand Down Expand Up @@ -74,7 +79,7 @@ Here is an example `test.html`
Your can start uitest using Node API:

```javascript
const uitest = require('uitest')
const uitest = require('uitest');

uitest({
url: 'file:///Users/name/path/index.html',
Expand All @@ -87,7 +92,7 @@ uitest({
console.log('uitest success')
}).catch(() => {
console.log('uitest error')
})
});
```

### Gulp
Expand All @@ -99,9 +104,9 @@ $ npm i gulp-uitest --save-dev
```

```javascript
const uitest = require('gulp-uitest')
const uitest = require('gulp-uitest');
//test
gulp.task('test', function () {
gulp.task('test', function() {
return gulp
.src('test/html/index.html')
.pipe(uitest({
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": "uitest",
"version": "1.1.4",
"version": "1.1.5",
"description": "uitest",
"keywords": [
"uitest"
Expand Down

0 comments on commit 7d6b1e8

Please sign in to comment.