Skip to content

Commit

Permalink
added basic docs
Browse files Browse the repository at this point in the history
  • Loading branch information
DavertMik committed Nov 22, 2015
1 parent 53fc149 commit 2e377b1
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 3 deletions.
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,39 @@
## Install

```sh
$ npm install --save codeceptjs
$ npm install -g codeceptjs
```


## Usage

```js
var codeceptjs = require('codeceptjs');
```
codeceptjs init
```

WIP

## Examples

```js
var assert = require('assert');
Feature('CodeceptJS Demonstration');

Scenario('test some forms', (I) => {
I.amOnPage('http://simple-form-bootstrap.plataformatec.com.br/documentation');
I.fillField('Email', 'hello@world.com');
I.fillField('Password', '123456');
I.checkOption('Active');
I.checkOption('Male');
I.click('Create User');
I.see('User is valid');
I.dontSeeInCurrentUrl('/documentation');
});

```

WIP

## License

MIT © [DavertMik](http://codegyre.com)
Expand Down
1 change: 1 addition & 0 deletions gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,5 @@ gulp.task('coveralls', ['test'], function () {
.pipe(coveralls());
});

gulp.task('prepublish', []);
gulp.task('default', ['static', 'test', 'coveralls']);

0 comments on commit 2e377b1

Please sign in to comment.