Skip to content

Commit e81ee94

Browse files
Improved install and update instructions (#3)
* [add] Making reference to go supported versions
1 parent 4d05760 commit e81ee94

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,33 @@ Several aspects can dictate the overall system performance, like the:
1010
- Number of subscribers per channel (controlled on subscriber)
1111
- Subscriber distribution per shard and channel (controlled on subscriber)
1212

13-
## Installation
1413

15-
The easiest way to get and install the Subscriber Go program is to use
16-
`go get` and then `go install`:
17-
```bash
18-
# Fetch this repo
14+
## Getting Started
15+
16+
### Installing
17+
This benchmark go program is **know to be supported for go >= 1.11**.
18+
The easiest way to get and install the Subscriber Go program is to use `go get` and then `go install`:
19+
20+
```
1921
go get github.com/filipecosta90/pubsub-sub-bench
2022
cd $GOPATH/src/github.com/filipecosta90/pubsub-sub-bench
2123
make
2224
```
2325

26+
#### Updating
27+
To update the Subscriber Go program use `go get -u` to retrieve the latest version:.
28+
```
29+
go get -u github.com/filipecosta90/pubsub-sub-bench
30+
cd $GOPATH/src/github.com/filipecosta90/pubsub-sub-bench
31+
make
32+
```
33+
34+
#### Limitations
35+
36+
There are know limitations on old go version due to the radix/v3 dependency, given that on old versions,
37+
the go command in GOPATH mode does not distinguish between major versions, meaning that it will look for the package `package github.com/mediocregopher/radix/v3` instead of v3 of `package github.com/mediocregopher/radix`.
38+
Therefore you should only use this tool on go >= 1.11.
39+
2440
## Usage of pubsub-sub-bench
2541

2642
```

0 commit comments

Comments
 (0)