Skip to content

Commit 4733ea0

Browse files
committed
README logo & link
1 parent ffe911b commit 4733ea0

2 files changed

Lines changed: 21 additions & 2 deletions

File tree

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/open-source-labs/Chronos)
88
![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
99
![Release: 4.0](https://img.shields.io/badge/Release-4.0-orange)
10+
![Build Passing](https://img.shields.io/badge/build-passing-brightgreen)
1011

1112
# Chronos
1213

@@ -17,6 +18,7 @@ Chronos is a comprehensive developer tool that monitors the health and web traff
1718
## Table of Contents
1819

1920
- [Features](#features)
21+
- [Demo](#demo)
2022
- [Branches](#branches)
2123
- [Master](#master)
2224
- [Middleware](#middleware)
@@ -52,6 +54,13 @@ Chronos is a comprehensive developer tool that monitors the health and web traff
5254
<br>
5355

5456
## Demo
57+
58+
Add text here<br>
59+
Add text here<br>
60+
Add text here<br>
61+
Add text here<br>
62+
Add text here<br>
63+
5564
<img src="./app/assets/Chronos-Demo.gif" alt="Chronos-Demo" title="Chronos-Demo" align="center" height="500" />
5665

5766
#
@@ -183,11 +192,18 @@ The `database` property is required and takes in the following:
183192
- <img src="./app/assets/important.png" alt="Important" title="Important" align="center" height="20" /> When starting up the container, give it the same name that you used for the microservice, because the middleware finds the correct container ID of your container by matching the container name to the microservice name you input as 1st argument.
184193
- <img src="./app/assets/important.png" alt="Important" title="Important" align="center" height="20" /> Don't forget to bind mount to Docker socket. -->
185194

186-
The `notifications` property is optional. Please see the section below to configure Slack or email notifications [here](#notifications).
195+
The `notifications` property is optional. Jump to the section below, [Notifications](#notifications) to configure <img src="./app/assets/slack-logo-color.png" alt="Slack" title="Slack" align="center" height="20" /> or email <img src="./app/assets/email-icon-black.png" alt="Slack" title="Slack" align="center" height="20" /> notifications.
187196
<br>
188197
<br>
189198

190199
### 4. Initialize Chronos
200+
201+
Add text here<br>
202+
Add text here<br>
203+
Add text here<br>
204+
Add text here<br>
205+
Add text here<br>
206+
191207
```js
192208
const cmd = require('chronos-tracker');
193209
require('./cmd-config'); // Bring in config file

package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,10 @@
3131
"@babel/plugin-proposal-class-properties"
3232
]
3333
},
34-
"keywords": [],
34+
"keywords": [
35+
"distributed tracing",
36+
"tracing"
37+
],
3538
"author": "",
3639
"license": "ISC",
3740
"dependencies": {

0 commit comments

Comments
 (0)