vndb/mithril-vndb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc fixes

Browse source
This commit is contained in:
Leo 2017-01-08 14:47:38 -05:00
parent 96ca6379d0
commit d40b324645
6 changed files with 42 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

21
ospec/README.md
View file

@ -4,7 +4,7 @@
Noiseless testing framework
Version: 1.2.3
Version: 1.2.3
License: MIT
## About
@ -278,28 +278,19 @@ ospec will automatically evaluate all `*.js` files in any folder named `/tests`.
$ npm test
```
#### (Optionally) Install Globally
#### Installing ospec globally
While it's recommended to install ospec locally to maintain reproducible environments, sometimes it may be deemed appropriate to install it globally. To do so, run this command:
```
$ npm i -g ospec
$ ospec
```
#### (Optionally) Evaluate ES6+ code:
One way to accomplish this would be to include the 'babel-cli' module (`npm i babel-cli`)
(This would pre-suppose that you're already using babel in your project and thus have it configured to your liking).
```
$ babel-node ospec
npm install ospec -g
```
---
## API
*Square brackets denote optional arguments
Square brackets denote optional arguments
### void o.spec(String title, Function tests)