From 3d295adf56d8c50752f419cca3073c4b2b9ca113 Mon Sep 17 00:00:00 2001 From: Cameron Sparr Date: Mon, 1 Feb 2016 15:49:19 -0700 Subject: [PATCH] README typos --- README.md | 53 +++++++++++++++++++++++++++-------------------------- 1 file changed, 27 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 08b5108..8410862 100644 --- a/README.md +++ b/README.md @@ -7,36 +7,37 @@ ICMP Ping library for Go, inspired by Here is a very simple example that sends & receives 3 packets: ```go - pinger, err := ping.NewPinger("www.google.com") - if err != nil { - panic(err) - } - pinger.Count = 3 - pinger.Run() // blocks until finished - stats := pinger.Statistics() // get send/receive/rtt stats +pinger, err := ping.NewPinger("www.google.com") +if err != nil { + panic(err) +} +pinger.Count = 3 +pinger.Run() // blocks until finished +stats := pinger.Statistics() // get send/receive/rtt stats ``` Here is an example that emulates the unix ping command: ```go - pinger, err := ping.NewPinger("www.google.com") - if err != nil { - fmt.Printf("ERROR: %s\n", err.Error()) - return - } - pinger.OnRecv = func(pkt *ping.Packet) { - fmt.Printf("%d bytes from %s: icmp_seq=%d time=%v\n", - pkt.Nbytes, pkt.IPAddr, pkt.Seq, pkt.Rtt) - } - pinger.OnFinish = func(stats *ping.Statistics) { - fmt.Printf("\n--- %s ping statistics ---\n", stats.Addr) - fmt.Printf("%d packets transmitted, %d packets received, %v%% packet loss\n", - stats.PacketsSent, stats.PacketsRecv, stats.PacketLoss) - fmt.Printf("round-trip min/avg/max/stddev = %v/%v/%v/%v\n", - stats.MinRtt, stats.AvgRtt, stats.MaxRtt, stats.StdDevRtt) - } - fmt.Printf("PING %s (%s):\n", pinger.Addr(), pinger.IPAddr()) - pinger.Run() +pinger, err := ping.NewPinger("www.google.com") +if err != nil { + panic(err) +} + +pinger.OnRecv = func(pkt *ping.Packet) { + fmt.Printf("%d bytes from %s: icmp_seq=%d time=%v\n", + pkt.Nbytes, pkt.IPAddr, pkt.Seq, pkt.Rtt) +} +pinger.OnFinish = func(stats *ping.Statistics) { + fmt.Printf("\n--- %s ping statistics ---\n", stats.Addr) + fmt.Printf("%d packets transmitted, %d packets received, %v%% packet loss\n", + stats.PacketsSent, stats.PacketsRecv, stats.PacketLoss) + fmt.Printf("round-trip min/avg/max/stddev = %v/%v/%v/%v\n", + stats.MinRtt, stats.AvgRtt, stats.MaxRtt, stats.StdDevRtt) +} + +fmt.Printf("PING %s (%s):\n", pinger.Addr(), pinger.IPAddr()) +pinger.Run() ``` It sends ICMP packet(s) and waits for a response. If it receives a response, @@ -44,7 +45,7 @@ it calls the "receive" callback. When it's finished, it calls the "finish" callback. For a full ping example, see -[cmd/ping/ping.go"](https://github.com/sparrc/go-ping/blob/master/cmd/ping/ping.go) +[cmd/ping/ping.go](https://github.com/sparrc/go-ping/blob/master/cmd/ping/ping.go) ## Installation: