Skip to content
This repository has been archived by the owner on Apr 13, 2020. It is now read-only.

Commit

Permalink
Update readme with tuxfile
Browse files Browse the repository at this point in the history
  • Loading branch information
danactive committed Mar 27, 2015
1 parent cef8bd4 commit 605b73b
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#Changelog
## v1.6.0 2015-Mar-27
## v1.6.1 2015-Mar-27
* Setup
* tuxfile.js is default recipe filename
* Dependency
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "tuxharness",
"version": "1.6.0",
"version": "1.6.1",
"description": "Test User eXperience Harness",
"main": "index.js",
"scripts": {
Expand Down
11 changes: 6 additions & 5 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,13 @@ Build a stand-alone test harness with dynamic data to quickly prototype and isol
## Installation steps to setup and configure
1. `npm install tuxharness --save-dev`
1. Create a **recipe** config JavaScript file (similar to *Gruntfile.js* or *gulpfile.js*)
* Any path or filename is allowed as defined in your project's *package.json*
* `tuxfile.js` or custom
* Custom means any path or filename is allowed as defined in your project's *package.json*
* Link your **package.json** to the **recipe** JavaScript file
* Add a key to your project's *package.json* named `tuxharness` with a relative path value to your recipe
* Sample syntax `"tuxharness": "./test/sample.js"` as documented in [package.json](package.json)
* The object structure must match the [recipe config structure](#recipe-config-structure) defined below
* [Starter sample tuxharness recipe](test/starter.js), [full sample](test/sample.js)
1. Link your **package.json** to the **recipe** JavaScript file
* Add a key to your project's *package.json* named `tuxharness` with a relative path value to your recipe
* Sample syntax `"tuxharness": "./test/sample.js"` as documented in [package.json](package.json)
* [Starter sample tuxharness recipe](test/starter.js) or [full sample](test/sample.js)
1. Run the harness
* `node ./node_modules/tuxharness/index.js`
* or add a *script* reference to your package.json like `"harness": "node ./node_modules/tuxharness/index.js"` then execute with `npm run harness`
Expand Down

0 comments on commit 605b73b

Please sign in to comment.