You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ Hare is a user-friendly lib for sockets in Golang. You can send and listen to TC
25
25
-[Contributing](#contributing)
26
26
-[License](#license)
27
27
28
-
## Installation
28
+
## 🖥️ Installation
29
29
30
30
First, you need [Go](https://golang.org/) installed (version 1.12+ is required), then you can install Hare:
31
31
@@ -47,7 +47,7 @@ $ brew tap leozz37/jaguar
47
47
$ brew install jaguar
48
48
```
49
49
50
-
## Quickstart
50
+
## 🍕 Quickstart
51
51
52
52
[Sample code](./examples/send.go) for sending payloads:
53
53
@@ -85,7 +85,7 @@ func main() {
85
85
}
86
86
```
87
87
88
-
## Documentation
88
+
## 📖 Documentation
89
89
90
90
The library consists of two features: **listen** and **send** to a given port. You can check the full documentation on [Godoc](https://pkg.go.dev/github.com/leozz37/hare#section-documentation).
91
91
@@ -195,7 +195,7 @@ func main() {
195
195
}
196
196
```
197
197
198
-
## Examples
198
+
## 📙 Examples
199
199
200
200
You can check the [example](./examples) for code usages, like [send](./examples/send.go) and [listen](./examples/listen.go) samples.
201
201
@@ -233,7 +233,7 @@ func main() {
233
233
}
234
234
```
235
235
236
-
## Testing
236
+
## 🧪 Testing
237
237
238
238
To run the test suite, you can run with:
239
239
@@ -247,7 +247,7 @@ If you want a more detailed report with coverage and an `coverage.out` file, do
247
247
$ go test -v -covermode=count -coverprofile=coverage.out
248
248
```
249
249
250
-
## Contributing
250
+
## 🤝 Contributing
251
251
252
252
A full guideline about contributing to Hare can be found in the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
253
253
@@ -316,6 +316,6 @@ of a ``*fix``).
316
316
317
317
Feel free to apply the labels from GitHub to the pull requests, they are very helpful.
318
318
319
-
## License
319
+
## ⚖️ License
320
320
321
321
Hare is released under the [MIT License](./LICENSE).
0 commit comments