Skip to content

Commit 0277c6b

Browse files
authored
Merge pull request #95 from markspolakovs/patch-1
Fix README formatting and grammar
2 parents a9bc812 + 56bc3e1 commit 0277c6b

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,21 @@ experience is poor, good or great
1212
For deploying to a test server, see the README under **ansible** folder.
1313

1414

15-
##Client Server Setup
15+
## Client Server Setup
1616
The application consists of a node/express software running the server and plain javascript/html on the client. The server
1717
powers reset endpoints, websocket communication, database interactions and the client website.
1818

19-
#Server
19+
# Server
2020
Index.js is the starting point of the app contains of the neccessary functions to run the application. Significant
2121
settings in this file are:
2222

23-
* Ip address and ports: the server will automatically bind to the ipv4 and ipv6 addresses of the host machine that it is deployed
24-
to (ie. app.listen(SERVERPORT,'::');). Addtionaly ports can be assigned with app.listen(ADDITIONALPORT);
23+
* IP address and ports: the server will automatically bind to the ipv4 and ipv6 addresses of the host machine that it is deployed to (ie. app.listen(SERVERPORT,'::');). Addtionaly ports can be assigned with app.listen(ADDITIONALPORT);
2524

2625
* Http Request: http configuration is defined to allow http posts and cross domain request.
2726

2827
* WebSockets: websockets communication is defined
2928

30-
* Rest endPoints: rest endpoints are exposed to complete a speed test and include the following:
29+
* REST endpoints: rest endpoints are exposed to complete a speed test and include the following:
3130
1. testplan: testplan will return json data containing the ipv4, ipv6 ipaddresses and ports used for rest endPoints
3231
and websockets running on the server and the client ipAddress. Also additional speed test features(ie. latency based
3332
routing flags can be returned)
@@ -39,7 +38,7 @@ to (ie. app.listen(SERVERPORT,'::');). Addtionaly ports can be assigned with app
3938
7. testServer: used in latency based routing.. it will return test servers urls that can
4039
be used to find the closet server to a client
4140

42-
* Configuration: Generic configuration(ports, latencyBasedRouting,...) are set in index.js. Specific customization(ie. database)
41+
* Configuration: Generic configuration (ports, latencyBasedRouting,...) are set in index.js. Specific customization(ie. database)
4342
can be place under the config folder
4443

4544
1. Configuration parameters
@@ -49,8 +48,8 @@ to (ie. app.listen(SERVERPORT,'::');). Addtionaly ports can be assigned with app
4948

5049
# Client
5150

52-
Client: Client application resides under the public folder and consists of plain javascript. Index.html is the
53-
default start page of the application and will contain an end to end example of aBandwidth Speed Test. The following describes
51+
Client: Client application resides in the public folder and consists of plain javascript. Index.html is the
52+
default start page of the application and will contain an end to end example of a Bandwidth Speed Test. The following describes
5453
the folder structure of the client application:
5554

5655
* lib: The lib folder contains javascript files used to measure bandwidth and related measurements.

0 commit comments

Comments
 (0)