Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Maurits Rijk committed Apr 10, 2017
1 parent 1af90a9 commit d9524ba
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
nodespec [![Build Status](https://travis-ci.org/mrijk/nodespec.svg)](https://travis-ci.org/mrijk/nodespec)
Speculaas [![Build Status](https://travis-ci.org/mrijk/nodespec.svg)](https://travis-ci.org/mrijk/nodespec)
[![Coverage Status](https://coveralls.io/repos/github/mrijk/nodespec/badge.svg?branch=master)](https://coveralls.io/github/mrijk/nodespec?branch=master)
======

NodeJS version of [clojure.spec](http://clojure.org/about/spec)

Disclaimer: for now mostly experimental, incomplete and potentially harmful ;)

## Installation

`npm install nodespec`
`npm install speculaas`

## Usage

Expand All @@ -18,9 +16,7 @@ For now, see the examples folder.

Unit tests:

```bash
$ npm test
```
`npm test`

Test coverage:

Expand All @@ -30,7 +26,15 @@ Run [ESlint](http://eslint.org):

`npm run lint`

For an alternative look at [js.spec](http://js-spec.online)
## FAQ

Q: what kind of a silly name is speculaas?

A: [nodespec](https://www.npmjs.com/package/nodespec) and [node-spec](https://www.npmjs.com/package/node-spec) where already taken. [Speculaas](https://en.wikipedia.org/wiki/Speculaas) is a kind of a Dutch/Belgium biscuit.

Q: any alternatives for your code?

A: for an alternative look at [js.spec](http://js-spec.online)

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "nodespec",
"name": "speculaas",
"version": "0.0.1",
"description": "",
"main": "index.js",
Expand Down

0 comments on commit d9524ba

Please sign in to comment.