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
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ Hare is a user-friendly lib for sockets in Golang. You can send and listen to TC
18
18
## Contents
19
19
20
20
-[Installation](#installation)
21
-
-[Quick start](#quick-start)
21
+
-[Quickstart](#quickstart)
22
22
-[Documentation](#documentation)
23
23
-[Examples](#examples)
24
24
-[Testing](#testing)
@@ -27,7 +27,7 @@ Hare is a user-friendly lib for sockets in Golang. You can send and listen to TC
27
27
28
28
## Installation
29
29
30
-
First you need [Go](https://golang.org/) installed (version 1.12+ is required), then you can install Hare:
30
+
First, you need [Go](https://golang.org/) installed (version 1.12+ is required), then you can install Hare:
31
31
32
32
```shell
33
33
$ go get -u "github.com/leozz37/hare"
@@ -47,7 +47,7 @@ $ brew tap leozz37/jaguar
47
47
$ brew install jaguar
48
48
```
49
49
50
-
## Quick start
50
+
## Quickstart
51
51
52
52
[Sample code](./examples/send.go) for sending payloads:
53
53
@@ -87,7 +87,7 @@ func main() {
87
87
88
88
## Documentation
89
89
90
-
The library consists on 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).
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
92
92
### Send
93
93
@@ -199,7 +199,7 @@ func main() {
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
202
-
Since Hare only listen and send messages, here's a complete example:
202
+
Since Hare only listens and send messages, here's a complete example:
203
203
204
204
```go
205
205
package main
@@ -249,7 +249,7 @@ $ go test -v -covermode=count -coverprofile=coverage.out
249
249
250
250
## Contributing
251
251
252
-
A full guideline about contributing to Alacritty can be found in the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
252
+
A full guideline about contributing to Hare can be found in the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
253
253
254
254
### Issues
255
255
@@ -265,7 +265,7 @@ Open your pull request against ```develop```.
265
265
266
266
You should add/modify tests to cover your proposed code changes.
267
267
268
-
Tests coverage should never go down from 90%.
268
+
Test coverage should never go down from 90%.
269
269
270
270
If your pull request contains a new feature, please document it on the README.
271
271
@@ -279,13 +279,13 @@ The ```develop``` is a **regular branch** which always contains the latest
279
279
accept the **sombrero of shame** if you do that.
280
280
281
281
The ```experimental``` is a **temporary branch** which contains a new feature or
282
-
ideia. You must use the following name convention: **experimental-brief-description**.
282
+
idea. You must use the following name convention: **experimental-brief-description**.
283
283
284
284
The ```feature``` is a **temporary branch** which contains a new feature under
285
-
development that latter will be merged against the development branch. You must
285
+
development that later will be merged against the development branch. You must
286
286
use the following name convention: **feature-brief-description**.
287
287
288
-
The ```bugfix``` is a **temporary branch** which contains necessary fix to be
288
+
The ```bugfix``` is a **temporary branch** which contains the necessary fix to be
289
289
applied **after** a specific release to be merged against the development branch.
290
290
You must use the following name convention: **bugfix-brief-description**.
291
291
@@ -305,7 +305,7 @@ order to control the version numbers.
305
305
The ```main```, ```develop``` and ```release``` branches have protection rules
306
306
against **push**.
307
307
308
-
In order to contribute you must create a new branch following the [branching](#branching)
308
+
To contribute you must create a new branch following the [branching](#branching)
309
309
guideline and once your work is done, open a **pull request** from your branch
0 commit comments