Merged Pull Request '#125 doc/examples_links->main : Update readme li…

…nks + info'

Update readme links + info

fiftyone.pipeline.cloudrequestengine/readme.md

@@ -8,18 +8,33 @@ The 51Degrees Pipeline API is a generic web request intelligence and data proces
 
 ## This package - fiftyone.pipeline.cloudrequestengine
 
-This package uses the `engines` class created by the `fiftyone.pipeline.engines`. It makes available:
+This package uses the `engines` class created by the [`fiftyone.pipeline.engines`](/fiftyone.pipeline.engines#readme.md). It makes available:
 
 * A `Cloud Request Engine` which calls the 51Degrees cloud service to fetch properties and metadata about them based on a provided resource key. Get a resource key at https://configure.51degrees.com/
 * A `Cloud Engine` template which reads data from the Cloud Request Engine.
 
 It is used by the cloud versions of the following 51Degrees engines:
 
-- **fiftyone.devicedetection** - A device detection engine
-- **fiftyone.location** - A geolocation lookup engine
+- [**fiftyone.devicedetection**](https://github.com/51Degrees/device-detection-node#readme) - A device detection engine
+- [**fiftyone.geolocation**](https://github.com/51Degrees/location-node#readme) - A geolocation lookup engine
 
 ## Installation
 
 ```
 npm install fiftyone.pipeline.cloudrequestengine
 ```
+
+## Tests
+
+To run tests you will need to install the `jest` library.
+
+```
+npm install jest --global
+```
+
+Then, navigate to the module directory and execute:
+
+```
+npm test
+```
+

fiftyone.pipeline.core/readme.md

@@ -11,24 +11,33 @@ This package definds the essential components of the Pipeline API such as `flow
 
 It can be used on its own or with the following additional packages.
 
-- **fiftyone.pipeline.engines** - Adds a specialized type of flow element called an engine which allows for additional features including an auto-updating data file for properties, a service called when a requested property is missing and a caching system.
+- [**fiftyone.pipeline.engines**](/fiftyone.pipeline.engines#readme.md) - Adds a specialized type of flow element called an engine which allows for additional features including an auto-updating data file for properties, a service called when a requested property is missing and a caching system.
 
 Engines created by 51Degrees including:
 
-- **fiftyone.devicedetection** - A device detection engine
-- **fiftyone.location** - A geolocation lookup engine
+- [**fiftyone.devicedetection**](https://github.com/51Degrees/device-detection-node#readme) - A device detection engine
+- [**fiftyone.geolocation**](https://github.com/51Degrees/location-node#readme) - A geolocation lookup engine
 
 Make use of the above along with the following additional packages:
 
-- **fiftyone.pipeline.engines.fiftyone** - Functionality specific to 51Degrees engines.
-- **fiftyone.pipeline.cloudrequestengine** - An engine used to make requests to the 51Degrees cloud service.
+- [**fiftyone.pipeline.engines.fiftyone**](/fiftyone.pipeline.engines.fiftyone#readme.md) - Functionality specific to 51Degrees engines.
+- [**fiftyone.pipeline.cloudrequestengine**](/fiftyone.pipeline.cloudrequestengine#readme.md) - An engine used to make requests to the 51Degrees cloud service.
 
 ## Installation
 
 ```
 npm install fiftyone.pipeline.core
 ```
 
+## Examples
+
+Examples can be found in the `examples/` folder. See below for a list of examples.
+
+| Example                                | Description |
+|----------------------------------------|-------------|
+| [simpleEvidenceFlowElement.js](/fiftyone.pipeline.core/examples/customFlowElements/simpleEvidenceFlowElement.js)                   |  Demonstrates how to create a custom flow element that takes some evidence (birthdate) and returns something related to that evidence (star sign). |
+| [clientSideEvidenceFlowElement.js](/fiftyone.pipeline.core/examples/customFlowElements/clientSideEvidenceFlowElement.js)                 | Demonstrates how to modify the flow element from the 'simple evidence' example to gather evidence from code running on the client device (i.e. JavaScript). |
+
 ## Tests
 
 To run tests you will need to install the `jest` library.
@@ -42,8 +51,3 @@ Then, navigate to the module directory and execute:
 ```
 npm test
 ```
-
-## Examples
-
-- **examples/customFlowElements/1-simpleEvidenceFlowElement.js** - Demonstrates how to create a custom flow element that takes some evidence (birthdate) and returns something related to that evidence (star sign)
-- **examples/customFlowelements/3-clientSideEvidenceFlowElement.js** - Demonstrates how to modify the flow element from the 'simple evidence' example to gather evidence from code running on the client device (i.e. JavaScript).

fiftyone.pipeline.engines.fiftyone/readme.md

@@ -8,7 +8,7 @@ The 51Degrees Pipeline API is a generic web request intelligence and data proces
 
 ## This package - fiftyone.pipeline.engines.fiftyone
 
-This package uses the `engines` class created by the `fiftyone.pipeline.engines`. It makes available:
+This package uses the `engines` class created by the [`fiftyone.pipeline.engines`](/fiftyone.pipeline.engines#readme.md). It makes available:
 
 * A `share usage` engine that is used to send usage information to 51Degrees. 
 
@@ -17,3 +17,17 @@ This package uses the `engines` class created by the `fiftyone.pipeline.engines`
 ```
 npm install fiftyone.pipeline.engines.fiftyone
 ```
+
+## Tests
+
+To run tests you will need to install the `jest` library.
+
+```
+npm install jest --global
+```
+
+Then, navigate to the module directory and execute:
+
+```
+npm test
+```

fiftyone.pipeline.engines/readme.md

@@ -8,28 +8,37 @@ The 51Degrees Pipeline API is a generic web request intelligence and data proces
 
 ## This package - fiftyone.pipeline.engines
 
-This package extends the `flow element` class created by the `fiftyone.pipeline.core` pacakge into a specialized type of flow element called an engine. This allows for additional features including:
+This package extends the `flow element` class created by the [`fiftyone.pipeline.core`](/fiftyone.pipeline.core#readme.md) pacakge into a specialized type of flow element called an engine. This allows for additional features including:
 
 * An auto-updating data file for properties
 * A service called when a requested property
 * A caching system and implementation of an LRU (least recently used) cache
 
 Engines created by 51Degrees:
 
-- **fiftyone.devicedetection** - A device detection engine
-- **fiftyone.location** - A geolocation lookup engine
+- [**fiftyone.devicedetection**](https://github.com/51Degrees/device-detection-node#readme) - A device detection engine
+- [**fiftyone.geolocation**](https://github.com/51Degrees/location-node#readme) - A geolocation lookup engine
 
 Make use of this package along with the following additional packages:
 
-- **fiftyone.pipeline.engines.fiftyone** - Functionality specific to 51Degrees engines.
-- **fiftyone.pipeline.cloudrequestengine** - An engine used to make requests to the 51Degrees cloud service.
+- [**fiftyone.pipeline.engines.fiftyone**](/fiftyone.pipeline.engines.fiftyone#readme.md) - Functionality specific to 51Degrees engines.
+- [**fiftyone.pipeline.cloudrequestengine**](/fiftyone.pipeline.cloudrequestengine#readme.md) - An engine used to make requests to the 51Degrees cloud service.
 
 ## Installation
 
 ```
 npm install fiftyone.pipeline.engines
 ```
 
+## Examples
+
+Examples can be found in the `examples/` folder. See below for a list of examples.
+
+| Example                                | Description |
+|----------------------------------------|-------------|
+| [onPremiseFlowElement.js](/fiftyone.pipeline.engines/examples/onPremiseFlowElement.js)                  |  Demonstrates the creation of an engine that uses an auto-updating datafile to populate properties. |
+| [caching.js](/fiftyone.pipeline.engines/examples/caching.js)                 | Demonstrates a custom cache that makes use of the result caching feature that engines provide. |
+
 ## Tests
 
 To run tests you will need to install the `jest` library.
@@ -43,8 +52,3 @@ Then, navigate to the module directory and execute:
 ```
 npm test
 ```
-
-## Examples
-
-- **examples/onPremiseFlowElement.js** - Demonstrates the creation of an engine that uses an auto-updating datafile to populate properties
-- **examples/caching.js** - Demonstrates a custom cache that makes use of the result caching feature that engines provide.

readme.md

@@ -17,10 +17,10 @@ but additional caution should be applied.
 ## Contents
 This repository contains 4 modules:
 
-- **fiftyone.pipeline.core** - Defines the essential components of the Pipeline API such as 'flow elements', 'flow data' and 'evidence'
-- **fiftyone.pipeline.engines** - Functionality for a specialized type of flow element called an engine.
-- **fiftyone.pipeline.engines.fiftyone** - Functionality specific to 51Degrees engines.
-- **fiftyone.pipeline.cloudrequestengine** - An engine used to make requests to the 51Degrees cloud service.
+- [**fiftyone.pipeline.core**](/fiftyone.pipeline.core#readme.md) - Defines the essential components of the Pipeline API such as 'flow elements', 'flow data' and 'evidence'
+- [**fiftyone.pipeline.engines**](/fiftyone.pipeline.engines#readme.md) - Functionality for a specialized type of flow element called an engine.
+- [**fiftyone.pipeline.engines.fiftyone**](/fiftyone.pipeline.engines.fiftyone#readme.md) - Functionality specific to 51Degrees engines.
+- [**fiftyone.pipeline.cloudrequestengine**](/fiftyone.pipeline.cloudrequestengine#readme.md) - An engine used to make requests to the 51Degrees cloud service.
 
 ## Installation
 
@@ -39,6 +39,25 @@ They can also be installed from this repository by running:
 npm install <path to module>
 ```
 
+## Examples
+
+There are several examples available that demonstrate how to make use of the Pipeline API in isolation. These are described in the table below.
+If you want examples that demonstrate how to use 51Degrees products such as device detection, then these are available in the corresponding [repository](https://github.com/51Degrees/device-detection-node) and on our [website](https://51degrees.com/documentation/_examples__device_detection__index.html).
+
+#### Core
+
+| Example                                | Description |
+|----------------------------------------|-------------|
+| [simpleEvidenceFlowElement.js](/fiftyone.pipeline.core/examples/customFlowElements/simpleEvidenceFlowElement.js)                   |  Demonstrates how to create a custom flow element that takes some evidence (birthdate) and returns something related to that evidence (star sign). |
+| [clientSideEvidenceFlowElement.js](/fiftyone.pipeline.core/examples/customFlowElements/clientSideEvidenceFlowElement.js)                 | Demonstrates how to modify the flow element from the 'simple evidence' example to gather evidence from code running on the client device (i.e. JavaScript). |
+
+#### Engines
+
+| Example                                | Description |
+|----------------------------------------|-------------|
+| [onPremiseFlowElement.js](/fiftyone.pipeline.engines/examples/onPremiseFlowElement.js)                  |  Demonstrates the creation of an engine that uses an auto-updating datafile to populate properties. |
+| [caching.js](/fiftyone.pipeline.engines/examples/caching.js)                 | Demonstrates a custom cache that makes use of the result caching feature that engines provide. |
+
 ## Tests
 Most modules include some automated tests. To run these, make sure jest is installed:
 
@@ -51,15 +70,3 @@ Then, navigate to the module directory and execute:
 ```
 npm test
 ```
-
-## Examples
-
-There are several examples available that demonstrate how to make use of the Pipeline API in isolation. These are described in the table below.
-If you want examples that demonstrate how to use 51Degrees products such as device detection, then these are available in the corresponding [repository](https://github.com/51Degrees/device-detection-node) and on our [website](https://51degrees.com/documentation/_examples__device_detection__index.html).
-
-| Example                                | Description |
-|----------------------------------------|-------------|
-| fiftyone.pipeline.core/examples/customFlowElements/simpleEvidenceFlowElement.js | Demonstrates how to create a custom flow element that takes some evidence (birthdate) and returns something related to that evidence (star sign) |
-| fiftyone.pipeline.core/examples/customFlowelements/clientSideEvidenceFlowElement.js | Demonstrates how to modify the flow element from the 'simple evidence' example to gather evidence from code running on the client device (i.e. JavaScript). |
-| fiftyone.pipeline.engines/examples/onPremiseFlowElement.js | Demonstrates the creation of an engine that uses an auto-updating datafile to populate properties |
-| fiftyone.pipeline.engines/examples/caching.js | Demonstrates a custom cache that makes use of the result caching feature that engines provide. |