Permalink
Browse files

documentation added...

  • Loading branch information...
1 parent e706f86 commit d4b7a99c0363738b012dddb8d97f9bd758844354 @victorjonsson committed Apr 18, 2012
Showing with 20 additions and 16 deletions.
  1. +6 −3 CHANGELOG.md
  2. +13 −12 README.md
  3. +1 −1 package.json
View
@@ -1,10 +1,10 @@
# Package Changelog
## v. 0.0.14
-First beta release
+ - First beta release
## v. 0.0.15
-Moved callback into a class function to make it possible for extending class to override the execute() function
+ - Moved callback into a class function to make it possible for extending class to override the execute() function
## v 0.0.16
- Added comments
@@ -17,4 +17,7 @@ Moved callback into a class function to make it possible for extending class to
- Now following redirects
- Fixed bug, callback function did not run on request error
- Fixed bug, not possible to use the same cookies for several tests
- - Extension of test files changed from .dokimon to .djs
+
+## v 0.0.18
+ - Extension of test files changed from .dokimon to .djs
+ - minor bug fixes
View
@@ -1,13 +1,14 @@
# Dokimon
-This project is supposed to end up in a nodejs module used for writing and running automated tests of various kinds.
-It's fast and easy to write the tests and you run them using a command line interface.
+This is a node module used for setting up automated tests of various kinds. It may also
+be used as an alternative (or complement) to client test tools such as Selenium. You write your
+tests in a heartbeat and run them using a command line interface.
<strong>Example usages:</strong>
- Verify that your online services is up and running
- Verfify that your RESTfull API is responding and behaving as expected
- - Validate that your website is spitting out expected html code
+ - Validate that your website generates expected html code
## Getting started
@@ -19,7 +20,7 @@ Create a directory where you find suitable, go to the directory in your shell in
``npm install dokimon``
### 4) Create test directory
-You write your tests in files that has the extension .dokimon...
+You write your tests in files that has the extension .djs (more information about writing the tests below).
### 3) config.json
This file should be placed in the root of your project directory and contain a JSON object with
@@ -49,16 +50,16 @@ will search for a file named config.json in current working directory if not spe
```
/Users/john/nodetests/
tests/
- - myscript.dokimon
+ - myscript.djs
- config.json
```
## Writing tests
You can have one or several dokimon scripts, each containing one or several tests. All dokimon scripts should have
-the extension <em>.dokimon</em> and be located in the test directory defined in config.json. The scripts is written as ordinary node modules (http://howtonode.org/creating-custom-modules).
+the extension <em>.djs</em> and be located in the test directory defined in config.json. The scripts is written as ordinary node modules (http://howtonode.org/creating-custom-modules).
-<strong>Basic example (myscript.dokimon)</strong>
+<strong>Basic example (myscript.djs)</strong>
```js
var dokimon = require('dokimon'),
@@ -100,7 +101,7 @@ var checkSiteSearch = new dokimon.TestPostForm(
module.exports = [checkHomepage,checkSiteSearch];
```
-Assuming that I've written this code in a file residing in my test directory (defined in config.json) and that the file has <em>.dokimon</em> as extension I can now run my tests by calling `dokimon -r` in the project directory. I can also choose to only run one the tests like `dokimon -rs myscript HomePageIsRunning`
+Assuming that I've written this code in a file residing in my test directory (defined in config.json) and that the file has <em>.djs</em> as extension I can now run my tests by calling `dokimon -r` in the project directory. I can also choose to only run one the tests like `dokimon -rs myscript HomePageIsRunning`
[Read more about writing tests here](https://github.com/victorjonsson/nodejs-dokimon/wiki/Writing-tests)
@@ -113,13 +114,13 @@ Run all dokimon scripts in the test directory defined in config.json
```
dokimon -r api website
```
-Run the scripts named api.dokimon and website.dokimon residing in the test directory defined in config.json. You can
-also write the paths to the scripts, -r tests/api.dokimon tests/website.dokimon
+Run the scripts named api.djs and website.djs residing in the test directory defined in config.json. You can
+also write the paths to the scripts, -r tests/api.djs tests/website.djs
```
dokimon -rs website HomePageIsRunning
```
-Run the test named <em>HomePageIsRunning</em> that's located in the script website.dokimon residing in the test
+Run the test named <em>HomePageIsRunning</em> that's located in the script website.djs residing in the test
directory defined in config.json
```
@@ -130,7 +131,7 @@ List all scripts (and their tests) that is located in the test directory, define
```
dokimon -s website
```
-List all available tests in the script website.dokimon
+List all available tests in the script website.djs
### Optional arguments
View
@@ -1,7 +1,7 @@
{
"author": "Victor Jonsson <kontakt@victorjonsson.se> (http://victorjonsson.se)",
"name": "dokimon",
- "description": "A simple framework that is used for test automation. Write tests for a website or web service and manage them with a command line interface",
+ "description": "This is a module used for setting up automated tests of various kinds. It may also be used as an alternative (or complement) to browser test tools such as Selenium. Write tests for a website or web service and manage them with a command line interface. Documentation available on github",
"version": "0.0.17",
"homepage": "https://github.com/victorjonsson/nodejs-dokimon",
"keywords": ["test","tests","scraping","node.js", "automation", "testing"],

0 comments on commit d4b7a99

Please sign in to comment.