Skip to content

Commit

Permalink
Added reference to other implementations
Browse files Browse the repository at this point in the history
  • Loading branch information
sohamkamani committed Oct 7, 2018
1 parent a650e15 commit 8afc2e7
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ Detective is a distributed application health monitoring library. It allows you
- [Composing instances](#composing-instances)
- [Circular dependencies](#circular-dependencies)
- [Dashboard](#dashboard)
- [Examples](#examples)
- [API documentation](#api-documentation)
- [Other implementations](#other-implementations)

## Usage

>For detailed documentation, visit the [Godocs page](https://godoc.org/github.com/sohamkamani/detective)
A typical service oriented architecture looks like this:

<p align="center"><img src="images/webapp-arch.png" width="70%"></p>
Expand Down Expand Up @@ -140,7 +141,7 @@ It's possible for two applications to depend on each other, either directly, or

The dashboard helps visualize your dependency tree and detect any faulty dependencies, along with their latency:

![dashbord picture](images/dashboard.png)
![dashboard picture](images/dashboard.png)

To run the dashboard, install the binary with:

Expand All @@ -156,4 +157,17 @@ 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.
You will then have to enter the URL of any detective endpoint to view its dashboard.

## Examples

- [Regular usage]((sample/regular-usage/main.go))
- [Composing instances](sample/composing-detective-instances/main.go)

## API documentation

Detailed API documentation can be found on the [GoDocs page]((https://godoc.org/github.com/sohamkamani/detective)

## Other implementations

The detective library has also been implemented in Node.js : [https://github.com/sohamkamani/detective-node](https://github.com/sohamkamani/detective-node), is iteroperable with this implementation, and can be used as an endpoint.

0 comments on commit 8afc2e7

Please sign in to comment.