Skip to content

Commit ded17fe

Browse files
docs: minor readme cleanup
1 parent 78e19ca commit ded17fe

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
The Signal Sciences module in Golang allows for integrating your Golang
77
application directly with the Signal Sciences agent at the source code
8-
level. It is written as an `http.Handler` wrapper. To
8+
level. It is written as a `http.Handler` wrapper. To
99
integrate your application with the module, you will need to wrap your
1010
existing handler with the module handler.
1111

@@ -14,7 +14,7 @@ existing handler with the module handler.
1414

1515
## Example Code Snippet
1616
```go
17-
// Existing http.Handler
17+
// Example existing http.Handler
1818
mux := http.NewServeMux()
1919
mux.HandleFunc("/", helloworld)
2020

@@ -44,21 +44,24 @@ log.Fatal(s.ListenAndServe())
4444

4545
## Examples
4646

47-
The [examples](examples/) directory contains complete example code.
47+
The [examples/helloworld](examples/helloworld) directory contains complete example code.
4848

4949
To run the simple [helloworld](examples/helloworld/main.go) example:
5050
```shell
51-
# Run __without__ sigsci enabled
51+
# Syntax:
52+
# go run ./examples/helloworld <listener-address:port> [<sigsci-agent-rpc-address>]
53+
#
54+
# Run WITHOUT sigsci enabled
5255
go run ./examples/helloworld localhost:8000
53-
# Run with sigsci-agent listening via a UNIX Domain socket file
56+
# Run WITH sigsci-agent listening via a UNIX Domain socket file
5457
go run ./examples/helloworld localhost:8000 /var/run/sigsci.sock
55-
# Run with sigsci-agent listening via a TCP address:port
58+
# Run WITH sigsci-agent listening via a TCP address:port
5659
go run ./examples/helloworld localhost:8000 localhost:9999
5760
```
5861

59-
This will run a HTTP listener on `localhost:8000`, which will send any
62+
The above will run a HTTP listener on `localhost:8000`, which will send any
6063
traffic to this listener to a running sigsci-agent for inspection (if
61-
configured).
64+
an agent address is configured).
6265

6366
[doc-img]: https://godoc.org/github.com/signalsciences/sigsci-module-golang?status.svg
6467
[doc]: https://godoc.org/github.com/signalsciences/sigsci-module-golang

0 commit comments

Comments
 (0)