Skip to content

Commit 035deac

Browse files
committed
README.md: Added PyPi badges, added pip instructions
1 parent cd18fa1 commit 035deac

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,41 @@
11
# IP ping
22

3+
![PyPI](https://img.shields.io/pypi/v/ipping)
4+
![PyPI - Status](https://img.shields.io/pypi/status/ipping)
5+
36
A [`ping(8)`](https://linux.die.net/man/8/ping) like network utility allowing use of TCP and UDP packets to measure round-trip and packet loss statistics.
47

58
Implemented in minimal-dependency pure Python 3.7+ using [asyncio-protocol](https://docs.python.org/3/library/asyncio-protocol.html).
69

7-
## UDP
10+
## Installation
811

9-
Sends UDP packets to a running UDP echo server.
12+
Get it from [pypi](https://pypi.org/project/ipping)
13+
14+
```sh
15+
pip install --upgrade ipping
16+
```
17+
18+
## Usage
1019

11-
### Echo server
20+
### UDP
21+
22+
Sends UDP packets to a running UDP echo server.
1223

1324
Echo server must be running on the machine we want to ping.
1425

15-
Using [`socat(1)`](https://linux.die.net/man/1/socat)
26+
Using [`socat(1)`](https://linux.die.net/man/1/socat):
1627

1728
```sh
1829
socat PIPE udp-recvfrom:5554,fork
1930
```
2031

21-
Using [`ncat(1)`](https://linux.die.net/man/1/ncat)
32+
Using [`ncat(1)`](https://linux.die.net/man/1/ncat):
2233

2334
```sh
2435
ncat -kule /bin/cat 5554
2536
```
2637

27-
### Example usage
38+
Run ping test:
2839

2940
```sh
3041
$ ipping udp 192.168.20.2 5554 -i 0.5 -s 8176 -c 4

0 commit comments

Comments
 (0)