Skip to content

Commit b06ba92

Browse files
authored
Merge pull request #22 from oslabs-beta/CHRONOS-91-Edit-README
Chronos 91 Edit README
2 parents 673f495 + bf9468c commit b06ba92

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

README.md

+13-4
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,15 @@ Contributors:
3232

3333
</div>
3434
Updates:
35-
<li>Forthcoming</li>
35+
<li>Improved runtime by incorporating esbuild-loader, removing deprecated syntax/unused node modules, and other bundling optimizations.</li>
36+
<li>Refactored SASS by updating deprecated syntax and import statements.</li>
37+
<li>Grafana dashboard updates include deprecated syntax removal and a more intuitive layout, making it simpler for users to visualize key metrics in the newest version of Grafana.</li>
38+
<li>TypeScript migration allows contributors and users to catch errors early and work with a more robust codebase, making the app more reliable.</li>
39+
<li>Introduced ChroNotes, full documentation of our file structure and their purposes.</li>
40+
<li>Refactored the UI of the app to give it a more intuitive appearance regarding where/how to initialize network monitoring.</li>
3641

3742

38-
<a href='link here'>Version 15.0 Medium Article</a>
43+
<a href='(https://ashleybisram.medium.com/a-new-chapter-for-chronos-introducing-version-15-0-12b83def342b)'>Version 15.0 Medium Article</a>
3944

4045
### **Iteration Log**
4146
<details><summary>Chronos 14.0</summary>
@@ -237,7 +242,7 @@ Updates:
237242
</ul>
238243
</details>
239244

240-
### With Chronos 14.0
245+
### With Chronos 15.0
241246

242247
<a href="https://chronoslany.com/">
243248
<img src="assets/demo.gif" alt="Chronos" title="Chronos" align="center" height="500" width="auto" />
@@ -247,10 +252,14 @@ Updates:
247252

248253
## Overview of the CodeBase
249254

255+
- In our ChroNotes, we have a full overview of all the files in the codebase, and their purpose.
256+
<a href='https://docs.google.com/document/d/e/2PACX-1vTWIX6Is3uuvWX73ab5K521X7Ddr_fVN64F82bJ8l4VNF45cM9PbfDj2gVV9MVi_HhDrbNmZK51-dHP/pub'>Click here to view</a>!
257+
<img src='./assets/ChroNotes.png' alt='ChroNotes screenshot' align='center' height='500'/>
250258
- If you want to visualize the way the files in the app are connected, we suggest using this data visualizer. Below, it's showing the same repository, but instead of a directory structure, each file and folder as a circle: the circle’s color is the type of file, and the circle’s size represents the size of the file. See live demo
251259
<a href='https://mango-dune-07a8b7110.1.azurestaticapps.net/?repo=oslabs-beta%2FChronos'>here</a>.
252260
<img src="assets/codebase_visulization.png" alt="codebase visulization" align="center" height="500"/>
253261

262+
254263
## Features
255264

256265
- Cloud-Based Instances:
@@ -266,7 +275,7 @@ Updates:
266275

267276
# Installation
268277

269-
This is for the latest Chronos **version 13.0 release**.
278+
This is for the latest Chronos **version 15.0 release**.
270279

271280
## NPM Package
272281

assets/ChroNotes.png

198 KB
Loading

0 commit comments

Comments
 (0)