Skip to content

Commit e0d93f2

Browse files
committed
README logo & link
1 parent 7c19776 commit e0d93f2

1 file changed

Lines changed: 13 additions & 15 deletions

File tree

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Chronos is a comprehensive developer tool that monitors the health and web traff
2929
- [Email](#email)
3030
- [Branches](#branches)
3131
- [Master](#master)
32+
- [Examples](#examples)
3233
- [Middleware](#middleware)
3334
- [Microservices](#microservices)
3435
- [Docker](#docker)
@@ -142,7 +143,7 @@ const express = require('express');
142143
const app = express());
143144
```
144145

145-
you will also need to require in `chronos-tracker` as well as the `./chronos-config` file:
146+
you will also need to require in `chronos-tracker` and initialize Chronos, as well as the `./chronos-config` file. You will then need to invoke `chronos.propagate()` to initiate the route tracing, in addition to implementing `chronos.track()` for all endpoints.
146147

147148
```js
148149
const chronos = require('chronos-tracker');
@@ -154,6 +155,9 @@ chronos.propagate();
154155
app.use('/', chronos.track());
155156
```
156157

158+
You should be good to go!
159+
160+
157161
#
158162
###### Return to [Top](#Chronos)
159163
<br>
@@ -220,20 +224,18 @@ notifications: [
220224

221225
### Master
222226

223-
The **'master'** branch of this repository is where the <img src="./app/assets/electron-logo-color.png" alt="Electron" title="Electron" align="center" height="20" /> application for Chronos is deployed. The Chronos monitoring tool's _default configuration_ includes two databases: one PostgresQL and one MongoDB, that are both connected and configured for you in the dashboard so you can easily view the metrics and graphs available to you.
227+
The **'master'** branch of this repository is where the <img src="./app/assets/electron-logo-color.png" alt="Electron" title="Electron" align="center" height="20" /> application for Chronos is deployed. The Chronos monitoring tool includes two database examples, one PostgresQL and one MongoDB, with sample data sets.
224228

225-
**NOTE:** To _replace_ or _override_ these two default databases that we provide, change the database URIs stored in the following path:
229+
**NOTE:** To _replace_ or _delete_ these two databases, simply change the database URIs stored in the following path:
226230
```
227231
root directory -> electron -> user -> settings.json
228232
```
229233

230-
### Middleware
234+
#### Examples
231235

232-
The **'middleware'** branch is what is ultimately deployed to the <img src="./app/assets/npm-logo-color.png" alt="NPM" title="NPM" align="center" height="20" /> package, which is what you will install and configure in your own application in order to use Chronos.
233-
<br>
234-
<br>
236+
We provide two working example microservice applications in the `master` branch for you to test out Chronos.
235237

236-
### Microservices
238+
#### Microservices
237239

238240
The **'dummy-microservice'** branch is where we provide a test suite of sample microservices 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="./app/assets/electron-logo-color.png" alt="Electron" title="Electron" align="center" height="20" /> app.
239241

@@ -243,7 +245,7 @@ Refer to the [README](https://github.com/oslabs-beta/Chronos/tree/docker/microse
243245
<br>
244246
<br>
245247

246-
### Docker
248+
#### Docker
247249

248250
The '<img src="./app/assets/docker-logo-color.png" alt="Docker" title="Docker" align="center" height="20" /> **/microservice'** branch is where we provide a sample _dockerized_ microservices application to test out Chronos and to apply distributed tracing across different containers for your testing convenience..
249251

@@ -267,15 +269,11 @@ volumes:
267269
```
268270
<br>
269271

270-
### ChronosWebsite
272+
### Middleware
271273

272-
The **'chronosWebsite'** branch is where the source code for the website, chronoslany.com, exists. The website currently has a working download link for Chronos as a desktop application for **MacOS**, and the Windows and Linux download links will redirect you to the <img src="./app/assets/apple-icon-black.png" alt="Apple" title="Apple" align="center" height="15" /> Apple Store to buy a Macbook Pro <img src="./app/assets/macbook-logo-color.png" alt="MacBook" title="MacBook" align="center" height="15" />.
274+
The **'middleware'** branch is the current codebase for the <img src="./app/assets/npm-logo-color.png" alt="NPM" title="NPM" align="center" height="20" /> package, which is what you will install in your own application in order to use Chronos.
273275
<br>
274-
<br>
275-
276-
### Others
277276

278-
Please feel free to ignore the other branches in the repository ('Demo', 'Dev')
279277
#
280278
###### Return to [Top](#Chronos)
281279
<br>

0 commit comments

Comments
 (0)