Skip to content

Commit be0f7b0

Browse files
author
Mikhail Podtserkovskiy
committed
readme fixes
1 parent e306e7b commit be0f7b0

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# ~~jsonwire-grid~~WebDriverGrid [![Build Status](https://travis-ci.org/qa-dev/jsonwire-grid.svg?branch=master)](https://travis-ci.org/qa-dev/jsonwire-grid)
22
This is high-performance scalable implementation of Selenium Grid (hub),
3+
> ######What is Selenium-Grid?
4+
>Selenium-Grid allows you run your tests on different machines against different browsers in parallel. That is, running multiple tests at the same time against different machines running different browsers and operating systems. Essentially, Selenium-Grid support distributed test execution. It allows for running your tests in a distributed test execution environment.
35
46
## Features
57
* One session per one node, no more no less😺
@@ -25,7 +27,7 @@ This is high-performance scalable implementation of Selenium Grid (hub),
2527

2628
### Run test
2729
1. Try create session, such as `curl -X POST http://127.0.0.1:4444/wd/hub/session -d '{"desiredCapabilities":{"browserName": "firefox"}}'`
28-
1. If your something similar with `{"state":null,"sessionId":"515be56a...` all right! If not, submit [issue](https://github.com/qa-dev/jsonwire-grid/issues/new)
30+
1. If you see something similar with `{"state":null,"sessionId":"515be56a...` all right! If not, submit [issue](https://github.com/qa-dev/jsonwire-grid/issues/new)
2931

3032

3133
## Configuration
@@ -35,10 +37,10 @@ This is high-performance scalable implementation of Selenium Grid (hub),
3537
### DB - Configuration of storage.
3638
##### `db.implementation` - Select your favorite db, or local storage.
3739
Now support's: `mysql`, `local`.
38-
>Note: Local (in-memory) storage not support single session storagen between grid-instances.
40+
>Note: Note: Local (in-memory) storage does not support common session storage between grid-instances.
3941
##### `db.connection` - DSN for your db
4042
* `mysql` - example `db_user:db_pass@(db_host:3306)/db_name?parseTime=true` (parseTime=true - required option)
41-
* `local` - omit this property, because every instance have own in-memory storage
43+
* `local` - omit this property, because every instance have its own in-memory storage
4244

4345
### Statsd - Configuration of metrics.
4446
##### `statsd.host` - Host of statsd server.
@@ -51,21 +53,21 @@ Now support's: `mysql`, `local`.
5153
##### `grid.client_type` - Type of used nodes.
5254
* `selenium` - [http://www.seleniumhq.org/]()
5355
* `wda` - [agent](https://github.com/qa-dev/WebDriverAgent) for [WDA](https://github.com/qa-dev/WebDriverAgent)
54-
##### `grid.port` - grit will run on this port.
56+
##### `grid.port` - grid will run on this port.
5557
##### `grid.busy_node_duration` - max session lifetime, when timeout was elapsed grid will kill the session.
56-
##### `grid.reserved_node_duration` - max timeout between send request `POST /session` and opening the browser window, if. (Deprecated will renamed)
58+
##### `grid.reserved_node_duration` - max timeout between send request `POST /session` and opening the browser window. (Deprecated will renamed)
5759
##### `grid.strategy_list` - list of strategies, if grid not able create session on first strategy it go to next, until list ends. [Read more about strategies.](#strategy-list)
5860

5961
### Strategy list
6062
##### `type` - [type of strategy.](#types-of-strategies)
61-
##### `limit` - max count active nodes of this strategy. Unlimited if equals `0`. Dependent of strategy [type](#types-of-strategies)
62-
##### `params` - object describes available nodes `ex. docker config, kubernetes config, etc.`. Dependent of strategy [type](#types-of-strategies)
63-
##### `node_list` - list of objects describes available nodes.
64-
##### `node_list.[].params` - list of objects describes available nodes `ex. image_name, etc.`. Dependent of strategy [type](#types-of-strategies)
63+
##### `limit` - max count of active nodes on this strategy. Unlimited if equals `0`. Dependent on strategy [type](#types-of-strategies)
64+
##### `params` - object describes available nodes `ex. docker config, kubernetes config, etc.`. Dependent on strategy [type](#types-of-strategies)
65+
##### `node_list` - list of objects describing available nodes.
66+
##### `node_list.[].params` - list of objects describing available nodes `ex. image_name, etc.`. Dependent on strategy [type](#types-of-strategies)
6567
##### `node_list.[].capabilities_list` - array of available capabilities objects. `ex. [{"foo: "bar"}, {"foo: "baz", "ololo": "trololo"}]`
6668

67-
### Types of strategies
68-
##### `persistent` - working with registered nodes, same as original selenium grid.
69+
### Types of strategy
70+
##### `persistent` - using externally started nodes, same as original selenium grid.
6971
* `limit` - omit this property, its always equals `0`.
7072
* `node_list` - omit this property.
7173
##### `kubernetes` - on-demand nodes in kubernetes cluster.

0 commit comments

Comments
 (0)