Skip to content

Commit 3d5d2b1

Browse files
committed
Refactor README [skip ci]
1 parent e71f28f commit 3d5d2b1

File tree

5 files changed

+21
-19
lines changed

5 files changed

+21
-19
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
1-
## ASGI Monitor
2-
[![license](https://img.shields.io/github/license/draincoder/asgi-monitor)](https://github.com/draincoder/asgi-monitor/blob/master/LICENSE)
3-
[![test](https://github.com/draincoder/asgi-monitor/actions/workflows/ci.yaml/badge.svg)](https://github.com/draincoder/asgi-monitor/actions/workflows/ci.yaml)
4-
[![PyPI version](https://badge.fury.io/py/asgi-monitor.svg)](https://pypi.python.org/pypi/asgi-monitor)
5-
[![Supported versions](https://img.shields.io/pypi/pyversions/asgi-monitor.svg)](https://pypi.python.org/pypi/asgi-monitor)
6-
[![downloads](https://img.shields.io/pypi/dm/asgi-monitor.svg)](https://pypistats.org/packages/asgi-monitor)
7-
8-
A library for easy and fast configuration of logging, tracing and monitoring of ASGI applications.
1+
<div align="center">
2+
<pictire>
3+
<img alt="asgi-monitor logo" src="docs/images/logo.png" height="300">
4+
</pictire>
5+
6+
<hr>
7+
8+
[![PyPI version](https://badge.fury.io/py/asgi-monitor.svg)](https://pypi.python.org/pypi/asgi-monitor)
9+
[![Test](https://github.com/draincoder/asgi-monitor/actions/workflows/ci.yaml/badge.svg)](https://github.com/draincoder/asgi-monitor/actions/workflows/ci.yaml)
10+
[![Supported versions](https://img.shields.io/pypi/pyversions/asgi-monitor.svg)](https://pypi.python.org/pypi/asgi-monitor)
11+
[![Downloads](https://img.shields.io/pypi/dm/asgi-monitor.svg)](https://pypistats.org/packages/asgi-monitor)
12+
[![License](https://img.shields.io/github/license/draincoder/asgi-monitor)](https://github.com/draincoder/asgi-monitor/blob/master/LICENSE)
13+
14+
</div>
15+
16+
17+
### A library for easy and fast configuration of logging, tracing and monitoring of ASGI applications.
File renamed without changes.

docs/images/logo.png

39 KB
Loading
File renamed without changes.

examples/real_world/README.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,14 @@
1-
## Start example in Docker
1+
### Start example in Docker
22

33
```shell
44
docker compose -f examples/real_world/docker-compose.yaml --profile api --profile grafana up --build -d
55
```
66

7-
## Stop example in Docker
7+
### Stop example in Docker
88

99
```shell
1010
docker compose -f examples/real_world/docker-compose.yaml --profile api --profile grafana down
1111
```
1212

13-
## Grafana - http://127.0.0.1:3000/
14-
15-
### API Metrics dashboard
16-
![Dashboard](./pictures/dashboard.png)
17-
18-
### Tempo traces from dashboard logs
19-
![Traces](./pictures/traces.png)
20-
21-
## Swagger - http://127.0.0.1:8080/docs/
13+
#### `Grafana:` http://127.0.0.1:3000/
14+
#### `Swagger:` http://127.0.0.1:8080/docs/

0 commit comments

Comments
 (0)