further linked NPM README to examples, added screenshoots for docker example, revised npm package README

Author: beezoo10

README.md

@@ -129,8 +129,9 @@ We provide eight example applications for you to test out both the Chronos NPM p
 - Kubernetes
     - [Kubernetes README](./examples/kubernetes/README.md)
 - Microservices
-    - [microservices README](./examples/microservices/README.md)
+    - [Microservices README](./examples/microservices/README.md)
 
+Additional documentation on how Chronos is used **in each example** can be found in the [Chronos NPM Package README](./chronos_npm_package/README.md).
 
 #### _AWS_
 
@@ -175,9 +176,15 @@ In the `microservices` folder, we provide a sample microservice application that
 Refer to the [microservices README](./examples/microservices/README.md) in the `microservices` folder for more details.
 #
 
+# Testing
+
+We've created testing suites for Chronos with React Testing and Jest - instructions on running them can be found in the [testing README](./__tests__/README.md).
+#
 ## Contributing
 
-Development of Chronos is open source on GitHub through the tech accelerator umbrella OS Labs, and we are grateful to the community for contributing bug fixes and improvements. Read our [contributing README](https://github.com/oslabs-beta/Chronos/blob/master/CONTRIBUTING.md) to learn how you can take part in improving Chronos.
+Development of Chronos is open source on GitHub through the tech accelerator OS Labs, and we are grateful to the community for contributing bug fixes and improvements. 
+
+Read our [contributing README](../../CONTRIBUTING.md) to learn how you can take part in improving Chronos.
 
 ### **Last Iterating Team**
 
@@ -216,8 +223,7 @@ Development of Chronos is open source on GitHub through the tech accelerator umb
 
 ## License
 
-Chronos is [MIT licensed.](https://github.com/oslabs-beta/Chronos/blob/master/LICENSE.md)
-
+[MIT](https://github.com/oslabs-beta/Chronos/blob/master/LICENSE.md)
 #
 
 ###### Return to [Top](#chronos)

__tests__/README.md

@@ -5,7 +5,6 @@
 1. React Testing Library versions 13+ require React v18. If your project uses an older version of React, be sure to install version 12
 ```
 npm install --save-dev @testing-library/react@12
-
 ``` 
 2. install additional packages
 ```
@@ -55,12 +54,9 @@ module.exports = {
 
 6. use `npm run test` to run jest tests
 
-### Contributing
+## Contributing
 
 Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
 
-### People
-[Snow X. Bai](https://github.com/xueapp)
-[Taylor Zhang](https://github.com/taylrzhang)
-[Tim Lee](https://github.com/timlee12)
-[Roberto Meloni](https://github.com/RobertoRueMeloni)
+Read our [contributing README](../../CONTRIBUTING.md) to further learn how you can take part in improving Chronos.
+

assets/examples_docker_data.png

@@ -1,15 +1,7 @@
-# Chronos
-Visit our splash page at [chronoslany.com](https://chronoslany.com/)
-
-Chronos is a comprehensive developer tool that monitors the health and web traffic of servers, microservices, and containers. Use Chronos to see real-time data monitoring and receive automated notifications over Slack or email.
-
-#
-
 ## What's New?
 - Bug Fixes
 - Refactored code for additional modularity and customization
 - Ability for developers to increase number of metrics monitored for microservices
-
 #
 
 ## Features 
@@ -32,7 +24,6 @@ Install the package as a dependency in each of the microservices you want to tra
 npm install @chronosmicro/tracker
 ```
 
-<br>
 
 ### Configuring Chronos Tracker
 Create a `.js` Chronos configuration file (hereby referred to as `chronos-config.js`), which exports a JavaScript object with required Chronos configuration parameters. This object will be used as the sole Chronos class constructor argument. Feel free to use a `.env` file to hold sensitive parameters like the database URI, for example.
@@ -79,7 +70,6 @@ const Chronos = require('@chronosmicro/tracker');
 const chronos = new Chronos(chronosConfig);
 ```
 
-<br>
 
 #### Chronos Configuration Parameters
 _See mode-specific configuration descriptions in the "Chronos Tracker for Microservices" section_
@@ -141,14 +131,13 @@ Chronos provides the option to send  emails. The properties that should be provi
 - `user` - The email address (string) of the sender
 - `password` - The password (string) of the sender email
 
-_NOTE: Email notification settings may require alternative security settings to work_
 
-<br>
+**NOTE: Email notification settings may require alternative security settings to work**
 
 ### Chronos Tracker for "Microservices" Mode
 The mode `microservices` uses the additional setting `dockerized`, which indicates whether or not the microservice has been containerized with Docker. If omitted, Chronos will assume this server is not running in a container, i.e. `dockerized` will default to _false_. 
 
-Setting the flag to _false_ will collect metrics from the host computer directly, while _true_ indicates for Chronos to pull metrics from the Docker daemon.
+Setting the flag to `false` will collect metrics from the host computer directly, while `true` indicates for Chronos to pull metrics from the Docker daemon.
 
 ```js
 // Excerpt from a chronos-config.js
@@ -172,7 +161,9 @@ const chronos = new Chronos(chronosConfig);
 chronos.track()
 ```
 
-If you are using an Express.js REST API, calling `Chronos.track()` returns middleware that allows users to track incoming network requests and outgoing their corresponding outgoing responses by marking them with unique IDs using `Chronos.propagate`. If you want to utilize this feature, setup a catchall route that will serve as a pass through for tracking and chain in the middleware from `Chronos.track`.
+If you are using an Express.js REST API, calling `Chronos.track()` returns middleware that allows users to track incoming network requests and outgoing their corresponding outgoing responses by marking them with unique IDs using `Chronos.propagate`.
+
+If you want to utilize this feature, setup a catchall route that will serve as a pass through for tracking and chain in the middleware from `Chronos.track`.
 
 ```js
 const chronosConfig = require('./chronos-config.js');
@@ -208,7 +199,6 @@ If you're using `docker-compose` to start up multiple containers, you can add a
 volumes:
   - "/var/run/docker.sock:/var/run/docker.sock"
 ```
-<br>
 
 ### Chronos Tracker for "Kubernetes" Mode
 Chronos can monitor an Kubernetes clusters by saving metric data from instant queries to a Prometheus server in your Kubernetes cluster. 
@@ -238,7 +228,6 @@ const Chronos = require('@chronosmicro/tracker');
 const chronos = new Chronos(chronosConfig);
 
 chronos.kubernetes();
-
 ```
 
 
@@ -261,7 +250,7 @@ module.exports = {
 }
 ```
 
-Then, in ***ONE AND ONLY ONE** of your microservices, call `Chronos.kafka`: 
+Then, in **ONE AND ONLY ONE** of your microservices, call `Chronos.kafka`: 
 ```js
 const chronosConfig = require('./chronos-config.js');
 const Chronos = require('@chronosmicro/tracker');
@@ -397,14 +386,10 @@ chronos.link(client, ServerWrapper);
 ### Viewing Chronos Data
 Once you have configured and intialized Chronos Tracker, it will automatically record monitoring data when your servers are running. The data will be saved into your database of choice, and then start the Chronos desktop app to view by cloning our [GitHub repo](https://github.com/open-source-labs/Chronos). Folow the ReadMe in that repo to setup the Chronos desktop app. 
 
-<br>
 
 ## Examples
 
-We provide working example microservice applications in Chronos desktop app repo in the *examples* folder.
-[GitHub repo](https://github.com/open-source-labs/Chronos)
-
-#
+We provide working example microservice applications in Chronos desktop app repo in the [**examples**](../chronos_npm_package/README.md) folder.
 
 ## Technologies
 - Electron
@@ -421,18 +406,16 @@ We provide working example microservice applications in Chronos desktop app repo
 - Docker
 - Kubernetes
 
-#
 
 ## Contributing
 
-Development of Chronos is open source on GitHub through the tech accelerator umbrella OS Labs, and we are grateful to the community for contributing bug fixes and improvements. Read below to learn how you can take part in improving Chronos.
+Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
 
-[Contributing](https://github.com/oslabs-beta/Chronos/blob/master/CONTRIBUTING.md)
+Read our [contributing README](../../CONTRIBUTING.md) to further learn how you can take part in improving Chronos.
 
-#
 
 ## License
 
-Chronos is MIT licenced 
+[MIT](https://github.com/oslabs-beta/Chronos/blob/master/LICENSE.md)
 #
 ###### Return to [Top](#chronos)

assets/examples_docker_removed.png

@@ -124,8 +124,10 @@ git archive -v -o myMM.zip --format=zip HEAD
 2. Select `cloud-based`
 
 3. Use Access Key, Secret Access Key, region, and EC2 instance ID to start monitoring EC2 instance. 
-
 ## Contributing
+
 Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
 
+Read our [contributing README](../../CONTRIBUTING.md) to further learn how you can take part in improving Chronos.
+
 

assets/examples_docker_stop.png

@@ -69,6 +69,8 @@ Step 7: Deploy test application in ECS
 ### Some notes about the ECS-test
 
 The way deployment set up is using Fargate, you will not be able to see graphs in ECS cluster->metrics. Instead, check inside services or Cloudwatch.
-
 ## Contributing
+
 Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
+
+Read our [contributing README](../../CONTRIBUTING.md) to further learn how you can take part in improving Chronos.

chronos_npm_package/README.md

@@ -1,13 +1,25 @@
 # Chronos Dockerized Microservices Example
 
 This sample microservices architecture allows developers to explore the functionality of Chronos but with one docker compose command. This consists of four microservices, which are contained within the directories:
-- Reverse Proxy / Frontend
-- Books
-- Customers
-- Orders
+- books
+- customers
+- frontend
+- orders
 
-Each microservice has its own server, which receives requests from both the client and from other microservices. Books, Customers, and Orders also have their own databases, which they can query to respond to those requests.
-The frontend has a reverse proxy set up for proxying requests to the appropriate service in the microservice network. Bear in mind that the use of the word 'services' refers to the individual applications in the microservice network. In development they're all run separately on different ports, with said ports listening out for requests. This is for demonstration and testing purposes. Ideally, in a production environment, all the services will be up and running concurrently from the get go and that's what the docker compose file helps us achieve. It is able to chain all the services and run them together with one command. Docker also ensures that the versions that worked well on dev are bundled up and distributed and used to run the containers for the individual containers.
+Each microservice has its own server, which receives requests from both the client and from other microservices.
+- _books_, _customers_, and _orders_ also have their own databases, which they can query to respond to those requests.
+
+The frontend has a reverse proxy set up for proxying requests to the appropriate service (individual application) in the microservice network. 
+
+In development they're all run separately on different ports, with said ports listening out for requests. This is for demonstration and testing purposes. 
+
+Ideally, in a production environment, all the services will be up and running concurrently from the get go and that's what the `docker-compose.yml` file helps us achieve. It is able to chain all the services and run them together with one command. 
+
+Docker also ensures that the versions that worked well on dev are bundled up and distributed and used to run the containers for the individual containers.
+
+## Additional Documentation
+
+For additional details on how Chronos works this example, please review the Docker section in the [Chronos NPM Package README](../../chronos_npm_package/README.md).
 
 ## Steps to Run Example
 Peform the following steps in each of the _books_, _customers_, _frontend_, and _orders_ directories
@@ -17,34 +29,58 @@ Peform the following steps in each of the _books_, _customers_, _frontend_, and
 
 ```
 CHRONOS_DB = MongoDB or PostgreSQL
-CHRONOS_URI = The URI to the desired MongoDB or PostgreSQL database to save health metrics via **Chronos**
-BOOK_URI = A **MongoDB** URI for the bookserver microservice to use
-CUSTOMER_URI = A **MongoDB** URI for the customerserver microservice to use
-ORDER_URI =  A **MongoDB** URI for the orderserver microservice to use
+CHRONOS_URI = The URI to the desired MongoDB or PostgreSQL database to save health metrics via Chronos
+BOOK_URI = A MongoDB URI for the bookserver microservice to use
+CUSTOMER_URI = A MongoDB URI for the customerserver microservice to use
+ORDER_URI = A MongoDB URI for the orderserver microservice to use
 ```
-2.  Verify that @chronosmicro/tracker is a dependency in each of the /books, /customers, /frontend, and /orders folders (see the `package.json` in each folder).
+2.  Verify that `@chronosmicro/tracker` is a dependency in each of the _books_, _customers_, _frontend_, and _orders_ folders (see the `package.json` in each folder).
 
-- If the @chronosmicro/tracker dependency is listed as a remote npm package (i.e. `"@chronosmicro/tracker": "^8.0.3"`) and you've ran *npm install*, no further work is needed continue to step 3. If you have the dependency as `"@chronosmicro/tracker": "file:./chronos_npm_package"`, make sure to change the version from `"file:./chronos_npm_package"` to `"^8.0.3"` and run npm install.
+    - If the @chronosmicro/tracker dependency is listed as a **remote** npm package (i.e. `"@chronosmicro/tracker": "^11.0.1"`) and you've ran `npm install`, no further work is needed continue to step 3.
 
-3. With the terminal navigated to the the examples/docker folder, run the command:
+    - If you have the dependency as
+    `"@chronosmicro/tracker": "file:./chronos_npm_package"`, which is a **local** file, make sure to change the version from `"file:./chronos_npm_package"` to `"^11.0.1"` and run npm install.
+
+3. With the terminal navigated to the the _examples/docker_ folder, run the command:
 ```
 docker-compose -f docker-compose.yml up
 ```
 
 # 
 
-You should now see the containers running in your terminal, each reporting "Docker data recorded in...". If this is being displayed for the books, customers, frontend, and orders microservices then the example is successfully saving health metrics to your database of choice!
+You should now see the containers running in your terminal, each reporting `"Docker data recorded in..."`. 
+
+<p align="center">
+  <img alt="docker data being recorded" src="../../assets/examples_docker_data.png">
+</p>
 
-*If there is any error when running the applications and the underlying files for a microservice were changed, be sure to delete the previous image before calling `docker-compose -f docker-compose.yml up` again. If you do not, the docker compose command will not know to rebuild the image and the code changes meant to fix any issues will not be rolled into the existing Docker image!*
+If this is being displayed for the books, customers, frontend, and orders microservices then the example is successfully saving health metrics to your database of choice!
+
+If there is any error when running the applications and the underlying files for a microservice were changed, be sure to delete the previous image before calling `docker-compose -f docker-compose.yml up` again. 
+
+- If you do not, the above docker compose command will not know to rebuild the image and the code changes meant to fix any issues will not be rolled into the existing Docker image!
 
 Your microservice health metrics can now be viewed at the given `CHRONOS_URI` or, preferrably, in the Electron.js desktop application.
 
+## To stop and remove containers
+
+To stop containers, use `^C`.
+
+<p align="center">
+  <img alt="docker containers stopped" src="../../assets/examples_docker_stop.png">
+</p>
 
-# To stop and remove containers
-Use `docker compose down` to stop containers
+Use `docker compose down` to remove.
 
+<p align="center">
+  <img alt="docker containers removed" src="../../assets/examples_docker_removed.png">
+</p>
 
 ## Contributing
+
 Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
+
+Read our [contributing README](../../CONTRIBUTING.md) to further learn how you can take part in improving Chronos.
 ## License
-[MIT](LICENSE)
+
+[MIT](https://github.com/oslabs-beta/Chronos/blob/master/LICENSE.md)

examples/AWS/AWS-EC2/README.md

@@ -9,6 +9,11 @@ This sample microservices architecture allows developers to explore the function
 
 Each microservice has its own server, which receives requests from both the client and from other microservices. Books, Customers, and Orders also have their own databases, which they can query to respond to those requests.
 
+
+## Additional Documentation
+
+For additional information on how Chronos works this example, please review the gRPC section in the [Chronos NPM Package README](../../chronos_npm_package/README.md).
+
 ## Getting Started w/ gRPC Example Microservices 
 
 Follow **'main'** branch [README](../../README.md) steps: Pre-Installation, Install Dependencies before start. 
@@ -56,9 +61,11 @@ Inside the downloaded directory, install all dependencies using the `npm install
 
 Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
 
+Read our [contributing README](../../CONTRIBUTING.md) to further learn how you can take part in improving Chronos.
+
 ## License
 
-[MIT](LICENSE)
+[MIT](https://github.com/oslabs-beta/Chronos/blob/master/LICENSE.md)
 
 [npm-image]: https://img.shields.io/npm/v/chronos-microservice-debugger3.svg
 [npm-url]: https://www.npmjs.com/package/chronos-microservice-debugger3