Skip to content

Commit 5597cb5

Browse files
committed
Fix typos
1 parent ad4d72a commit 5597cb5

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Hare is a user-friendly lib for sockets in Golang. You can send and listen to TC
1818
## Contents
1919

2020
- [Installation](#installation)
21-
- [Quick start](#quick-start)
21+
- [Quickstart](#quickstart)
2222
- [Documentation](#documentation)
2323
- [Examples](#examples)
2424
- [Testing](#testing)
@@ -27,7 +27,7 @@ Hare is a user-friendly lib for sockets in Golang. You can send and listen to TC
2727

2828
## Installation
2929

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:
3131

3232
```shell
3333
$ go get -u "github.com/leozz37/hare"
@@ -47,7 +47,7 @@ $ brew tap leozz37/jaguar
4747
$ brew install jaguar
4848
```
4949

50-
## Quick start
50+
## Quickstart
5151

5252
[Sample code](./examples/send.go) for sending payloads:
5353

@@ -87,7 +87,7 @@ func main() {
8787

8888
## Documentation
8989

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).
9191

9292
### Send
9393

@@ -199,7 +199,7 @@ func main() {
199199
200200
You can check the [example](./examples) for code usages, like [send](./examples/send.go) and [listen](./examples/listen.go) samples.
201201
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:
203203
204204
```go
205205
package main
@@ -249,7 +249,7 @@ $ go test -v -covermode=count -coverprofile=coverage.out
249249
250250
## Contributing
251251
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.
253253
254254
### Issues
255255
@@ -265,7 +265,7 @@ Open your pull request against ```develop```.
265265
266266
You should add/modify tests to cover your proposed code changes.
267267
268-
Tests coverage should never go down from 90%.
268+
Test coverage should never go down from 90%.
269269
270270
If your pull request contains a new feature, please document it on the README.
271271
@@ -279,13 +279,13 @@ The ```develop``` is a **regular branch** which always contains the latest
279279
accept the **sombrero of shame** if you do that.
280280
281281
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**.
283283
284284
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
286286
use the following name convention: **feature-brief-description**.
287287
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
289289
applied **after** a specific release to be merged against the development branch.
290290
You must use the following name convention: **bugfix-brief-description**.
291291
@@ -305,7 +305,7 @@ order to control the version numbers.
305305
The ```main```, ```develop``` and ```release``` branches have protection rules
306306
against **push**.
307307
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)
309309
guideline and once your work is done, open a **pull request** from your branch
310310
to the **develop** branch.
311311

0 commit comments

Comments
 (0)