Skip to content

Commit 1ff1890

Browse files
committed
Updated the readme for the API section installation and some tidy up
1 parent e6cf0e4 commit 1ff1890

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

readme.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ Wraith uses a json based configuration file that allows you specify a large numb
3232
Below is an example configuration file:
3333

3434
{
35-
Optional name for the project, if supplied it will be used within the generated gallery only
35+
Optional name for the project, if supplied it will be used within the generated
36+
gallery only
3637
"project": "Test",
3738

3839
Specify one or two domains
@@ -41,14 +42,17 @@ Below is an example configuration file:
4142
"http://live.bbc.co.uk"
4243
],
4344

44-
Engines supported are phantomjs and slimerjs but in theory any phantomjs based headless browser can be supported.
45+
Engines supported are phantomjs and slimerjs but in theory any phantomjs based
46+
headless browser can be supported.
4547

4648
To do cross browser testing specify one domain and two engines or your choice
4749
"engines": [
4850
"phantomjs"
4951
],
5052

51-
Specify as many sizes as you wish. If no sizes are specified then the most popular sizes will be used based on the information provided by w3counter.com stats
53+
Specify as many sizes as you wish. If no sizes are specified then the most
54+
popular sizes will be used based on the information provided by
55+
w3counter.com stats
5256
"sizes": [
5357
"320",
5458
"768",
@@ -59,8 +63,8 @@ Below is an example configuration file:
5963
"outputDir": "test/chrome/",
6064

6165
You can specify a list of paths to be used or you can crawl the site.
62-
63-
Note: If paths are provided they will take precedent and the spider file will be ignored.
66+
Note: If paths are provided they will take precedent and the spider file
67+
will be ignored.
6468

6569
"paths": [
6670
"/",
@@ -70,15 +74,20 @@ Below is an example configuration file:
7074
"/weather/"
7175
],
7276

73-
If no paths are specified then a site crawl will take place and the results will be save in the location specified within this option
77+
If no paths are specified then a site crawl will take place and the results
78+
will be save in the location specified within this option
7479
"spider": "spider/test.txt",
7580

7681
Limit the amount of concurrent processes
7782
"maxConnections": 20
7883
}
7984

8085
###API
81-
This is very basic at the minute but you can use wraith within your applications. At the minute there is only one option which is to run the application with a given config file and then run a specified callback but I am looking to expand this in the future.
86+
This is very basic at the minute but you can use wraith within your applications.
87+
88+
At the minute there is only one option which is to run the application with a given config file and then run a specified callback but I am looking to expand this in the future.
89+
90+
npm install wraith --save-dev
8291

8392
var wraith = require('wraith');
8493
var config = require('./config/chrome');
@@ -87,7 +96,8 @@ This is very basic at the minute but you can use wraith within your applications
8796
console.log('Callback, do something else here!');
8897
});
8998

90-
As the config is just an object you can change it at any point before calling the wraith function e.g.
99+
As the config is just an object you can change it at any point before calling
100+
the wraith function e.g.
91101

92102
config.maxConnections = 10;
93103
config.quiet = true;

0 commit comments

Comments
 (0)