|
1 | 1 |  |
2 | 2 |
|
3 | | -# What is Chronos? |
4 | | -A tool for visualizing communication and health throughout a microservices application |
| 3 | +Microservice communication and health visualizer. |
5 | 4 |
|
6 | | -## How can I use Chronos? |
7 | | -1. Go to https://www.npmjs.com/package/chronos-microservice-debugger and follow the instructions to install the NPM package within each microservice of your application |
8 | | -2. Download this repo |
9 | | -3. Inside the downloaded directory, run `npm install` followed by `npm start` |
| 5 | +[![NPM Version][npm-image]][npm-url] |
| 6 | +[![NPM Downloads][downloads-image]][downloads-url] |
| 7 | + |
| 8 | +```js |
| 9 | +const cmd = require('chronos-microservice-debugger3') |
| 10 | +cmd.propagate() |
| 11 | + |
| 12 | +app.use('/', cmd.microCom('microserviceName', 'databaseType', 'databaseURL', 'wantMicroHealth', 'queryFrequency')) |
| 13 | +``` |
| 14 | + |
| 15 | +## Installation |
| 16 | + |
| 17 | +This is a [Node.js](https://nodejs.org/en/) module available through the |
| 18 | +[npm registry](https://www.npmjs.com/). |
| 19 | + |
| 20 | +Before installing, [download and install Node.js](https://nodejs.org/en/download/). |
| 21 | +Node.js 0.10 or higher is required. |
| 22 | + |
| 23 | +Installation is done using the |
| 24 | +[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally): |
| 25 | + |
| 26 | +```bash |
| 27 | +$ npm install chronos-microservice-debugger3 |
| 28 | +``` |
| 29 | + |
| 30 | +## Features |
| 31 | + |
| 32 | + * HTTP request tracing |
| 33 | + * Speed and latency tracking |
| 34 | + * Process monitoring |
| 35 | + * Memory usage |
| 36 | + |
| 37 | +## Contributing |
10 | 38 |
|
11 | | -## How can I contribute to Chronos? |
12 | 39 | Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request. |
13 | 40 |
|
14 | | -## Who created Chronos? |
15 | | -* Mohtasim Chowdhury |
16 | | -* Natalie Umanzor |
17 | | -* Michelle Herrera |
18 | | -* Duane McFarlane |
19 | | -* Ben Mizel |
20 | | -* Timothy Atapagra |
21 | | -* Jenae Pennie |
22 | | -* Chris Romano |
23 | | -* Ousman Diallo |
| 41 | +## People |
| 42 | + |
| 43 | +[List of all contributors](https://github.com/Chronos2-0/Chronos/graphs/contributors) |
| 44 | + |
| 45 | +## License |
| 46 | + |
| 47 | + [MIT](LICENSE) |
24 | 48 |
|
| 49 | +[npm-image]: https://img.shields.io/npm/v/chronos-microservice-debugger3.svg |
| 50 | +[npm-url]: https://www.npmjs.com/package/chronos-microservice-debugger3 |
| 51 | +[downloads-image]: https://img.shields.io/npm/dm/chronos-microservice-debugger3.svg |
| 52 | +[downloads-url]: https://npmjs.org/package/chronos-microservice-debugger3 |
| 53 | + |
| 54 | +## How can I use Chronos? |
| 55 | +1. Go to https://www.npmjs.com/package/chronos-microservice-debugger and follow the instructions to install the NPM package within each microservice of your application |
| 56 | +2. Download this repo |
| 57 | +3. Inside the downloaded directory, run `npm install` followed by `npm start` |
0 commit comments