Merge pull request #21 from Chronos2-0/ben-mizel-patch-2

Ben mizel patch 2

Author: Dialloousman

README.md

@@ -1,22 +1,110 @@
-# What is Chronos?
-A tool for visualizing communication and health throughout a microservices application
+![Chronos logo](https://raw.githubusercontent.com/Chronos2-0/Chronos/master/app/assets/logo2.png)
+## Chronos
+Microservice communication and health visualizer.
 
-## How can I use Chronos?
-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
-2. Download this repo
-3. Inside the downloaded directory, run `npm install` followed by `npm start`
+[![NPM Version][npm-image]][npm-url]
+[![NPM Downloads][downloads-image]][downloads-url]
+
+```js
+const cmd = require('chronos-microservice-debugger3')
+cmd.propagate()
+
+app.use('/', cmd.microCom('microserviceName', 'databaseType', 'databaseURL', 'wantMicroHealth', 'queryFrequency'))
+```
+
+## Features
+
+  * HTTP request tracing
+  * Speed and latency tracking
+  * Process monitoring
+  * Memory usage
+
+## Installation
+
+Chronos consists of a [Node](https://nodejs.org/en/) module available through the
+[npm registry](https://www.npmjs.com/) and a lightweight [Electron](https://electronjs.org/) desktop application.
+
+#### Node module
+
+To begin, install the [Chronos](https://www.npmjs.com/package/chronos-microservice-debugger3) node module within each microservice of your application using the
+[`npm install`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally)command:
+
+```
+npm install chronos-microservice-debugger3
+```
+
+Once installed, write the following two lines at the top of each microservice's server file:
+```javascript
+const cmd = require('chronos-microservice-debugger3');
+cmd.propagate();
+```
+
+Then add a route handler for all incoming requests:
+```js
+app.use('/', cmd.microCom('microserviceName', 'databaseType', 'databaseURL', 'wantMicroHealth', 'queryFrequency'))
+```
+
+The cmd.microCom handler function logs communication and health data to a user-provided database. This is to ensure that your private data stays private. We currently support MongoDB and SQL/PostgreSQL databases.
+
+cmd.microCom takes four parameters and an optional fifth parameter. You can enter the arguments as individual strings or as an array.
+
+The parameters are:
+1. microserviceName: To identify the microservice (i.e. "payments")
+2. databaseType: Enter either "mongo" or "sql"
+3. databaseURL: Enter the URL of your database
+4. wantMicroHealth: Do you want to monitor the health of this microservice? Enter "yes" or "no"
+5. queryFrequency (optional): How frequently do you want to log the health of this microservice? It defaults to every minute, but you can choose:
+  * "s" : every second
+  * "m" : every minute (default)
+  * "h" : every hour
+  * "d" : once per day
+  * "w" : once per week
+
+String parameter example:
+```javascript
+app.use('/', cmd.microCom('payments', 'mongo', 'mongodb+srv://user:[email protected]/','yes','h'))
+```
+
+Array parameter example:
+```javascript
+let values = [
+  'payments',
+  'mongo',
+  'mongodb+srv://user:[email protected]/',
+  'yes',
+  'h'
+]
+
+app.use('/', cmd.microCom(values)
+```
+
+#### Electron desktop application
+
+After installing the node module in each microservice, download the Electron desktop application from the public [Chronos](https://github.com/Chronos2-0/Chronos) repo.
+
+Inside the downloaded directory, install all dependencies using the `npm install` command followed by the `npm start` command to start the Electron desktop application.
+
+## Contributing
 
-## How can I contribute to Chronos?
 Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
 
-## Who created Chronos?
-* Mohtasim Chowdhury
-* Natalie Umanzor
-* Michelle Herrera
-* Duane McFarlane
-* Ben Mizel
-* Timothy Atapagra
-* Jenae Pennie
-* Chris Romano
-* Ousman Diallo
+## People
+
+[Tim Atapagra](https://github.com/orgs/Chronos2-0/people/timpagra),
+[Mohtasim Chowdhury](https://github.com/mohtasim317),
+[Ousman Diallo](https://github.com/orgs/Chronos2-0/people/Dialloousman),
+[Michelle Herrera](https://github.com/mesherrera),
+[Duane McFarlane](https://github.com/Duane11003),
+[Ben Mizel](https://github.com/orgs/Chronos2-0/people/ben-mizel),
+[Jenae Pennie](https://github.com/orgs/Chronos2-0/people/jenaepen),
+[Chris Romano](https://github.com/orgs/Chronos2-0/people/robicano22),
+[Natalie Umanzor](https://github.com/nmczormick)
+
+## License
+
+  [MIT](LICENSE)
 
+[npm-image]: https://img.shields.io/npm/v/chronos-microservice-debugger3.svg
+[npm-url]: https://www.npmjs.com/package/chronos-microservice-debugger3
+[downloads-image]: https://img.shields.io/npm/dm/chronos-microservice-debugger3.svg
+[downloads-url]: https://npmjs.org/package/chronos-microservice-debugger3