Skip to content

Commit

Permalink
docs(init): init documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Raphaël Benitte committed Jun 28, 2017
1 parent 0957cc6 commit 15e0d30
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 2 deletions.
63 changes: 62 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,62 @@
# veggies
# veggies

[![NPM version][npm-image]][npm-url]
[![Travis CI][travis-image]][travis-url]
[![Coverage Status][coverage-image]][coverage-url]
[![styled with prettier][prettier-image]][prettier-url]

Veggies is an awesome cucumberjs boilerplate for API testing.
Great for testing APIs built upon Express, Koa, HAPI, Loopback, and others.

- [Installation](#installation)
- [Features](#features)
- [API testing](#api-testing)

## Installation

Using npm:

``` sh
npm install @ekino/veggies
```

Or yarn:

``` sh
yarn add @ekino/veggies
```

Then all you have to do is installing the provided extensions:

``` javascript
// /support/world.js

const { defineSupportCode } = require('cucumber')
const { state, httpApi } = require('@ekino/veggies')

defineSupportCode(({ setWorldConstructor }) => {
setWorldConstructor(function() {
state.extendWorld(this)
httpApi.extendWorld(this)
})
})

state.install(defineSupportCode)
httpApi.install({
baseUrl: 'http://localhost:3000',
})(defineSupportCode)

```

## Features

### API testing

[npm-image]: https://img.shields.io/npm/v/@ekino/veggies.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/@ekino/veggies
[travis-image]: https://img.shields.io/travis/ekino/veggies.svg?style=flat-square
[travis-url]: https://travis-ci.org/ekino/veggies
[prettier-image]: https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square
[prettier-url]: https://github.com/prettier/prettier
[coverage-image]: https://img.shields.io/coveralls/ekino/veggies/master.svg?style=flat-square
[coverage-url]: https://coveralls.io/github/ekino/veggies?branch=master
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
{
"name": "veggies",
"version": "0.1.0",
"description": "Veggies is an awesome cucumber-js boilerplate for API/CLI testing. Great for Express, HAPI, Loopback, and others. Unbelievable greatness for life improvement.",
"tags": [
"bdd",
"cucumber",
"gherkin",
"testing"
"testing",
"api"
],
"main": "src/index.js",
"author": "plouc <https://github.com/plouc>",
Expand Down

0 comments on commit 15e0d30

Please sign in to comment.