Skip to content

Commit f3f8b38

Browse files
authored
Update README.md
1 parent 6e0cf40 commit f3f8b38

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,16 @@ app.use('/', cmd.microCom('microserviceName', 'databaseType', 'databaseURL', 'wa
2424
Chronos consists of a [Node](https://nodejs.org/en/) module available through the
2525
[npm registry](https://www.npmjs.com/) and a lightweight [Electron](https://electronjs.org/) desktop application.
2626

27+
#### Node module
28+
2729
To begin, install the [Chronos](https://www.npmjs.com/package/chronos-microservice-debugger3) node module within each microservice of your application using the
2830
[`npm install`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally)command:
2931

30-
```bash
31-
$ npm install chronos-microservice-debugger3
32+
```
33+
npm install chronos-microservice-debugger3
3234
```
3335

34-
Once installed, place the following two lines in the microservice's server file before requiring 'express':
36+
Once installed, write the following two lines at the top of each microservice's server file:
3537
```javascript
3638
const cmd = require('chronos-microservice-debugger3');
3739
cmd.propagate();
@@ -76,6 +78,12 @@ let values = [
7678
app.use('/', cmd.microCom(values)
7779
```
7880
81+
#### Electron desktop application
82+
83+
After installing the node module in each microservice, download the Electron desktop application from the public [Chronos](https://github.com/Chronos2-0/Chronos) repo.
84+
85+
Inside the downloaded directory, install all dependencies using the `npm install` command followed by the `npm start` to start the Electron desktop application.
86+
7987
## Contributing
8088
8189
Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.

0 commit comments

Comments
 (0)