Permalink
Browse files

Updates the readme

  • Loading branch information...
samhatoum committed Dec 22, 2015
1 parent c348ffd commit 1bdbc5e502ed3d63aad796af48f24a8743367916
View
102 README.md
@@ -1,54 +1,102 @@
[![Chimp by Xolv.io](./images/header.png?raw=true)](http://chimpjs.com)
# Chimp.js [![Circle CI](https://circleci.com/gh/xolvio/chimp.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/xolvio/chimp) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/xolvio/chimp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
An awesome developer-centric experience to writing tests with **realtime feedback** using Mocha or Cucumber.js (Jasmine soon).
[![Circle CI](https://circleci.com/gh/xolvio/chimp.svg?style=svg)](https://circleci.com/gh/xolvio/chimp) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/xolvio/chimp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
This package allows you to easily write the automating code in BDD using Cucumber.js or Mocha (Jasmine soon).
You can use chimp with any technology stack since it allows your to write your automation layer in JavaScript ( the language of the web.)
[Click here to see a demo](http://chimpjs.com).
![Chimp by Xolv.io](./images/header.png?raw=true)
Chimp can be used with *any technology stack* as it allows your to write your test automation in the language of the web: JavaScript.
### Realtime feedback?
Traditionally only available for unit testing, and now you can get super fast feedback for your acceptance and end-to-end tests:
## Installation
![Realtime feedback](./images/realtime.gif?raw=true)
You need to be sure you have the following prerequisite installed:
Set an `@focus` tag in the spec title, save a file, Chimp reruns the spec until you make it pass.
* Node & NPM
* Oracle Java 1.8+ - you need the JDK not JRE or the OpenJDK
* Google Chrome (or you can set the `--browser` flag and use any other browser like `firefox`, `phantomjs` and `safari`)
### Installation
```sh
npm install chimp
npm install -g chimp
```
Having trouble? See the full [documentation site](https://chimp.readme.io/docs/installation).
## Usage
### Usage
For development mode, you can use the watch mode:
```sh
./bin/chimp --watch
chimp --watch
```
You can also easily change the browser Chimp with `--browser`, e.g. `--browser=phantomjs`
On CI you can select the browser:
```sh
./bin/chimp --browser=firefox
### Documentation
You bet! Read the full [documentation site](http://chimp.readme.io/docs). Thank you to Readme.io for the OSS <3.
## Additional Features
###### Synchronous Javascript
![WebdriverIO](./images/wdio.png?raw=true)
We chose [WebdriverIO](http://webdriver.io) for it's awesome API and made it awesomer by converting it to a synchronous syntax:
```javascript
browser.url('http://google.com'); // SETUP
var title = browser.getTitle(); // EXECUTE
expect(title).to.equal('Google'); // VERIFY
```
## Documentation
You can read [read the full documentation here](http://chimp.readme.io/docs).
No callback-hell or confusing assertions with promises, just easy-to-read synchronous code that works as you expect it to.
###### Easy CI
![CI](./images/ci.png?raw=true)
# Using Meteor?
Chimp is tested on all the popular CI servers. We genuinely just want you to focus on writing tests and let us deal with all the boring bits!
Chimp comes with first-grade Meteor support out-of-the-box. You simply start chimp like this:
###### Mocha or Cucumber.js (Jasmine soon)
![Test Frameworks](./images/test-frameworks.png?raw=true)
## Usage
Some developers love to do BDD using Cucumber, others love Jasmine and Mocha, so we decided to give you the choice between what we believe are the best in class for writing end-to-end and acceptance tests.
For development mode, you can use the watch mode:
###### Client & Server
End-to-end and acceptance testing often require you to setup data on the server and reset state between specs.
Using our synchronous version of the [request module](https://www.npmjs.com/package/request#request-options-callback), you can call your server to reset your system or setup data like this:
```javascript
var userId = request({
url: 'http://localhost:3000/fixtures/createUser'
method: 'POST',
json: true,
body: {username: 'Bob', password: 't0ps3cret'}
});
```
Or if you are using Meteor, you can get fancy with our `server.execute` method:
```javascript
var privateSetting = server.execute(function(settingKey) {
return Meteor.settings[settingKey];
}, 'privateSetting')
```
###### Lots more
Chimp is PACKED with features that make your life easier. See the [documentation site](http://chimp.readme.io/docs) for more details.
## Using Meteor?
Chimp comes with first-grade Meteor support out-of-the-box. You simply start Chimp like this:
### Usage
In development mode, use the watch mode:
```sh
./bin/chimp --watch --ddp=http://localhost:3000
# start your Meteor app first
chimp --watch --ddp=http://localhost:3000
```
On CI you can select the browser:
On CI, can select the browser:
```sh
# start your Meteor app first
./bin/chimp --browser=firefox --ddp=http://localhost:3000
View
Binary file not shown.
View
Binary file not shown.
View
Binary file not shown.
View
Binary file not shown.
View
Binary file not shown.
View
Binary file not shown.

0 comments on commit 1bdbc5e

Please sign in to comment.