Skip to content

Commit 96c1f87

Browse files
authored
Merge pull request #1 from stefanrammo/main
Initial implementation: logger, example usage, and tests
2 parents 6e5c935 + 671a042 commit 96c1f87

9 files changed

Lines changed: 12248 additions & 2 deletions

File tree

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules/
2+
protos/

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,32 @@
1-
# CDPLogger Client for Javascript
2-
A simple Javascript interface to communicate with CDP applications containing a CDPLogger component to retrieve historic data.
1+
# CDPLogger Client for JavaScript
2+
3+
A simple JavaScript interface for communicating with CDP applications that include a CDPLogger component to retrieve historic data.
4+
5+
6+
## Installation
7+
8+
Clone the repository and install dependencies:
9+
10+
```bash
11+
npm install
12+
```
13+
14+
15+
## Running Tests
16+
To run the automatic tests with fake data, execute:
17+
18+
```bash
19+
npm test
20+
```
21+
22+
## Usage
23+
The index.js file contains a simple logger built for the CDP Studio example case.
24+
25+
1. Set up and run the Logger in CDP Studio.
26+
(Refer to Help → Framework - Data Logging → How to Setup Logging in Automation System)
27+
28+
2. Run the index.js file from the command line:
29+
30+
```bash
31+
node index.js
32+
```

0 commit comments

Comments
 (0)