Skip to content

Minor fix to readme #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Hypercubed wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Minor fix to readme #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,16 +66,18 @@ suite('DB', function() {
#### Setting Options

As not all code is equal, we need a way to change the running conditions for our benches. Options can currently be changed for
any given suite, and will be retained for any nested suites or benches of that suite.
any given suite, and will be retained for any nested suites or benches of that suite.

To set an option:

```js
suite('Make Tea', function () {
set('iterations', 10000);
set('type', 'static');
// ...
...
});
```

##### Defaults

Here are all available options and the default values:
Expand All @@ -97,7 +99,7 @@ check again (and repeat) until the requirement has been satisfied.
## Running Benchmarks

Running of your benchmarks is provided through `./bin/matcha`. The recommended approach is to add a devDependancy in your
`package.json` and then add a line to a `Makefile` or build tool. The `matcha` bin will accept a list of files to load or will
`package.json` and then add a line to a `Makefile` or build tool. The `matcha` bin will accept a list of files to load or will
look in the current working directory for a folder named `benchmark` and load all files.

$ matcha suite1.js suite2.js
Expand Down Expand Up @@ -156,17 +158,17 @@ Completely different, create csv formated rows for later processing.

## Contributing

Interested in contributing? Fork to get started. Contact [@logicalparadox](http://github.com/logicalparadox)
Interested in contributing? Fork to get started. Contact [@logicalparadox](http://github.com/logicalparadox)
if you are interested in being regular contributor.

##### Contibutors
##### Contibutors

* Jake Luer ([Github: @logicalparadox](http://github.com/logicalparadox)) ([Twitter: @jakeluer](http://twitter.com/jakeluer)) ([Website](http://alogicalparadox.com))
* Patrick Steele-Idem ([Github: @patrick-steele-idem](http://github.com/patrick-steele-idem)) ([Twitter: @psteeleidem](http://twitter.com/psteeleidem))

## Shoutouts

* [mocha](https://mochajs.org) inspired the suite/bench definition language.
* [mocha](https://mochajs.org) inspired the suite/bench definition language.

## License

Expand Down