fiftyone.pipeline.cloudrequestengine 4.4.97 → 4.4.99

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/readme.md +18 -3
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "fiftyone.pipeline.cloudrequestengine",
3
- "version": "4.4.97",
3
+ "version": "4.4.99",
4
4
  "description": "Cloud request engine for the 51Degrees Pipeline API",
5
5
  "keywords": [
6
6
  "51degrees",
package/readme.md CHANGED
@@ -8,18 +8,33 @@ The 51Degrees Pipeline API is a generic web request intelligence and data proces
8
8
 
9
9
  ## This package - fiftyone.pipeline.cloudrequestengine
10
10
 
11
- This package uses the `engines` class created by the `fiftyone.pipeline.engines`. It makes available:
11
+ This package uses the `engines` class created by the [`fiftyone.pipeline.engines`](/fiftyone.pipeline.engines#readme.md). It makes available:
12
12
 
13
13
  * 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/
14
14
  * A `Cloud Engine` template which reads data from the Cloud Request Engine.
15
15
 
16
16
  It is used by the cloud versions of the following 51Degrees engines:
17
17
 
18
- - **fiftyone.devicedetection** - A device detection engine
19
- - **fiftyone.location** - A geolocation lookup engine
18
+ - [**fiftyone.devicedetection**](https://github.com/51Degrees/device-detection-node#readme) - A device detection engine
19
+ - [**fiftyone.geolocation**](https://github.com/51Degrees/location-node#readme) - A geolocation lookup engine
20
20
 
21
21
  ## Installation
22
22
 
23
23
  ```
24
24
  npm install fiftyone.pipeline.cloudrequestengine
25
25
  ```
26
+
27
+ ## Tests
28
+
29
+ To run tests you will need to install the `jest` library.
30
+
31
+ ```
32
+ npm install jest --global
33
+ ```
34
+
35
+ Then, navigate to the module directory and execute:
36
+
37
+ ```
38
+ npm test
39
+ ```
40
+