Skip to content

Commit

Permalink
add table of contents
Browse files Browse the repository at this point in the history
  • Loading branch information
sohamkamani committed Sep 22, 2018
1 parent 32bfbae commit 530fbdb
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@

Detective is a distributed application health monitoring library. It allows you to monitor arbitrary dependencies in your application, and compose other detective instances to create a distributed monitoring framework.

- [Detective 🔎](#detective-%F0%9F%94%8E)
- [Usage](#usage)
- [Monitoring a single application](#monitoring-a-single-application)
- [Composing instances](#composing-instances)
- [Circular dependencies](#circular-dependencies)
- [Dashboard](#dashboard)

## Usage

>For detailed documentation, visit the [Godocs page](https://godoc.org/github.com/sohamkamani/detective)
Expand Down Expand Up @@ -55,7 +62,7 @@ The HTTP endpoint can then be used to monitor the health of the application. A `
}
```

## Composing instances
### Composing instances

The endpoint in the previous example can also be used by other detective instances. For example, an application that makes use of "Another application" can monitor it as well:

Expand Down Expand Up @@ -145,8 +152,8 @@ go install github.com/sohamkamani/detective/detective-dashboard
Then start the dashboard with:

```
## Starts dashboard on http://localhost:8080/
detective-dashboard -p 8080
## Starts dashboard on http://localhost:8080/
```

You will then have to enter the URL of any detective endpoint to view its dashboard.

0 comments on commit 530fbdb

Please sign in to comment.