general readme updated

Author: taylrzhang

README.md

@@ -10,25 +10,25 @@
 ![Release: 5.2](https://img.shields.io/badge/Release-5.1-orange)
 
 #
-# Chronos 
 
+# Chronos
 
 ### Star us on GitHub — it helps!
+
 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.
+Chronos is a comprehensive developer tool that monitors the health and web traffic of servers, microservices, containers, and now, Amazon Web Services (AWS). Use Chronos to see real-time data monitoring and receive automated notifications over Slack or email.
 
 #
 
 ## What's New?
-- Metric query tool so you can filter out specific metrics — now you only have to see what you want on the dashboard and reduce database bloat, keeping your database from being overwhelmed with data points that you don't actually need. 
-- Kubernetes metrics monitoring via Prometheus.
-- Additional metrics added, bringing Chronos up from only 12 to 100+ metrics that are currently available
-- Option to filter by category and individual metric, and flip between services and categories with ease
-- Apache Kafka monitoring capability, all you need to do is run Prometheus JMX exporter on the system your Chronos application is running on. A sample JMX config.yaml file is provided in the Chronos repository for a quick and easy setup, however you are free to configure however you like.
+
+- Option to choose between cloud hosted services and local services, now giving Chronos the ability to monitor instances and clusters on AWS' EC2 and ECS platforms.
+- An updated AWS Graphs Container to dynamically render plots for EC2 or ECS data fetched with electron using event listeners connecting to AWS CloudWatch w/ the aws-sdk package
+- A step-by-step instruction on setting up a new, functional EC2 instance and/or ECS cluster, ready to be monitored and tested by the app
 - Bug fixes and UI tweaks — Chronos is now a more seamless experience than ever.
 
-## Features 
+## Features
 
 - Distributed tracing enabled across microservices applications
 - Kubernetes monitoring via Prometheus server
@@ -38,22 +38,26 @@ Chronos is a comprehensive developer tool that monitors the health and web traff
 - Display and compare multiple microservice metrics in a single graph
 - Monitor an <a href="#"><img src="assets/pngwing.com.png" alt="Apache Kafka" title="Apache Kafka" align="center" height="20" /></a> cluster via the JMX Prometheus Exporter
 - Monitor a Kubernetes cluster via a Prometheus monitoring server
+- Monitor Amazon Web Services (AWS) instances and clusters <img src="assets/aws-logo-color.png" alt="AWS" title="AWS" align="center" height="20" /></a>
 
 #
 
 ## Installation
+
 This is for the latest Chronos **version 8 release**.
 
-**NOTE:** The Chronos tracker code is included in the *chronos_npm_package* folder for ease of development, but the published npm package can be downloaded by running `npm install @chronosmicro/tracker`
+**NOTE:** The Chronos tracker code is included in the _chronos_npm_package_ folder for ease of development, but the published npm package can be downloaded by running `npm install @chronosmicro/tracker`
 
 <br>
 
 ### Node Version
-Make sure you're running version 16.17.1 of <img src="assets/node-logo-color.png" alt="Node" title="Node" align="center" height="20" />, to align with the <img src="assets/node-logo-color.png" alt="Node" title="Node" align="center" height="20" /> version used by <img src="assets/electron-logo-color.png" alt="Electron" title="Electron" align="center" height="20" /> version 22. 
+
+Make sure you're running version 16.17.1 of <img src="assets/node-logo-color.png" alt="Node" title="Node" align="center" height="20" />, to align with the <img src="assets/node-logo-color.png" alt="Node" title="Node" align="center" height="20" /> version used by <img src="assets/electron-logo-color.png" alt="Electron" title="Electron" align="center" height="20" /> version 22.
 
 <br>
 
 ### WSL2 Environment
+
 If you wish to launch the Electron Application in an WSL2 envirronment(Ubuntu) you may need the following commands for an Electron window to appear
 
 - Install <a href='https://sourceforge.net/projects/vcxsrv/'>VcXsrv</a>
@@ -65,36 +69,43 @@ sudo apt install libgconf-2-4 libatk1.0-0 libatk-bridge2.0-0 libgdk-pixbuf2.0-0
 ```
 
 - After running your VcXsrv instance, run the following command in the terminal
+
 ```
 export DISPLAY="`sed -n 's/nameserver //p' /etc/resolv.conf`:0"
 ```
 
 <br>
 
 ### Running the Chronos Desktop App in Development Mode
+
 1. From the root directory, run `npm install`
 2. Open a terminal and run `npm run dev:app` to start the Webpack development server
 3. Open another terminal and run `npm run dev:electron` to start the Electron UI in development mode
 
 ### Packing the Chronos App into an Executable
+
 1. From the root directory, run `npm run build`
 2. Run `npm package`
 3. Find the `chronos.app` executable inside the newly created `release-builds` folder in the root directory.
 
 #
 
 ## Chronos Tracker Microservice Examples
+
 We provide three working example microservice applications branch for you to test out Chronos:
-- *examples/microservices*
-- *examples/docker*
-- *examples/kubernetes*
+
+- _examples/microservices_
+- _examples/docker_
+- _examples/kubernetes_
 
 #### _Microservices_
-In the `microservices` folder, we provide a sample microservice application that successfully utilizes Chronos to apply all the powerful, built-in features of our  monitoring tool. You can then visualize the data with the <img src="assets/electron-logo-color.png" alt="Electron" title="Electron" align="center" height="20" /></a> app.
+
+In the `microservices` folder, we provide a sample microservice application that successfully utilizes Chronos to apply all the powerful, built-in features of our monitoring tool. You can then visualize the data with the <img src="assets/electron-logo-color.png" alt="Electron" title="Electron" align="center" height="20" /></a> app.
 
 Refer to the [README](link) in the `microservices` folder for more details.
 
 #### _Docker_
+
 In the <a href="#"><img src="assets/docker-logo-color.png" alt="Docker" title="Docker" align="center" height="20" /></a> folder within the `master` branch, we provide a sample _dockerized_ microservices application to test out Chronos and to apply distributed tracing across different containers for your testing convenience.
 
 The `docker` folder includes individual <a href="#"><img src="assets/docker-logo-color.png" alt="Docker" title="Docker" align="center" height="20" /></a> files in their respective directories. A docker-compose.yml is in the root directory in case you'd like to deploy all services together.
@@ -104,18 +115,29 @@ Refer to the [README](link) in the `docker` folder for more details.
 <br>
 
 #### _Kubernetes_
-The `kubernetes` folder includes a React frontend and an Express server backend, and the Dockerfiles needed to containerize them for Kubernetes deployment. The *launch* folder includes the YAML files needed to configure the deployments, services, and configurations of the frontend, backend, and Prometheus server.
 
+The `kubernetes` folder includes a React frontend and an Express server backend, and the Dockerfiles needed to containerize them for Kubernetes deployment. The _launch_ folder includes the YAML files needed to configure the deployments, services, and configurations of the frontend, backend, and Prometheus server.
 
 Refer to the [README](link) in the `kubernetes` folder for more details.
 
 <br>
 
-## Chronos Website  
+#### _AWS_
+
+The `AWS` folder includes a instructions to create a new AWS. The _launch_ folder includes the YAML files needed to configure the deployments, services, and configurations of the frontend, backend, and Prometheus server.
+
+Refer to the [README](link) in the `AWS` folder for more details.
+
+<br>
+
+## Chronos Website
+
 The `chronosWebsite` branch holds the code for the splash page. Edit the website by checking out the branch, modifying the website, and then updating the AWS S3 bucket with the changes.
 
 #
+
 ###### Return to [Top](#chronos)
+
 <br>
 
 ## Technologies
@@ -129,7 +151,7 @@ The `chronosWebsite` branch holds the code for the splash page. Edit the website
 - <a href="#"><img src="assets/node-logo-color.png" alt="Node" title="Node" align="center" height="30" /></a>
 - <a href="#"><img src="assets/express-logo-color.png" alt="Express" title="Express" align="center" height="30" /></a>
 - <a href="#"><img src="assets/http-logo-color.png" alt="HTTP" title="HTTP" align="center" height="30" /></a>
-- <a href="#"><img src="assets/grpc-logo-color.png" alt="gRPC" title="gRPC" align="center" height="30" /></a> 
+- <a href="#"><img src="assets/grpc-logo-color.png" alt="gRPC" title="gRPC" align="center" height="30" /></a>
 - <a href="#"><img src="assets/graphql-logo-color.png" alt="GraphQL" title="GraphQL" align="center" height="30" /></a>
 - <a href="#"><img src="assets/docker-logo-color.png" alt="Docker" title="Docker" align="center" height="30" /></a>
 - <a href="#"><img src="assets/aws-logo-color.png" alt="AWS" title="AWS" align="center" height="30" /></a>
@@ -147,10 +169,13 @@ The `chronosWebsite` branch holds the code for the splash page. Edit the website
 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.
 
 - [Contributing](https://github.com/oslabs-beta/Chronos/blob/master/CONTRIBUTING.md)
+
 #
 
 ## License
 
 Chronos is [MIT licensed.](https://github.com/oslabs-beta/Chronos/blob/master/LICENSE.md)
+
 #
+
 ###### Return to [Top](#chronos)