Skip to content

Commit b2568f5

Browse files
committed
update readme
1 parent 14bfd9d commit b2568f5

2 files changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,14 @@ top in container.
55
Running the original `top` command in a container will not get information of the container, many metrics like uptime, users, load average, tasks, cpu, memory, are about the host in fact.
66
`topic`(**top** **i**n **c**ontainer) will retrieve those metrics from container instead, and shows the status of the container, not the host.
77

8-
## how to use
8+
Below shows a container of 1 cpu and 1 Gi running status when stress with `--cpu 2`.
99

10-
Just download `topic` from GitHub [release page](https://github.com/silenceshell/topic/releases) to the container which you want to inspect, and add `x` attribute to the binary, then run the binary!
10+
![topic.png](doc/image/topic.png)
1111

12-
## how to build
12+
## How to use
13+
14+
Download `topic` from GitHub [release page](https://github.com/silenceshell/topic/releases) to the container which you want to inspect, and add `x` attribute to the binary, then run the binary!
15+
16+
## How to build
1317

1418
Run `make build` for linux and amd64. `topic` only support on linux. If you want to run on other architectures, `GOARCH` is need to be set.

doc/image/topic.png

76.4 KB
Loading

0 commit comments

Comments
 (0)