Skip to content

Commit 3117e4e

Browse files
committed
replace gx instructions with note about gomod
1 parent adf56ab commit 3117e4e

File tree

1 file changed

+4
-15
lines changed

1 file changed

+4
-15
lines changed

README.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -34,24 +34,13 @@ Note: This package largely replaces the functionality of [go-libp2p-conn](https:
3434
go get github.com/libp2p/go-libp2p-transport-upgrader
3535
```
3636

37-
Note that `go-libp2p-transport-upgrader` is packaged with Gx, so it is recommended to use Gx to install and use it (see the Usage section).
37+
This repo is [gomod](https://github.com/golang/go/wiki/Modules)-compatible, and users of
38+
go 1.11 and later with modules enabled will automatically pull the latest tagged release
39+
by referencing this package. Upgrades to future releases can be managed using `go get`,
40+
or by editing your `go.mod` file as [described by the gomod documentation](https://github.com/golang/go/wiki/Modules#how-to-upgrade-and-downgrade-dependencies).
3841

3942
## Usage
4043

41-
This module is packaged with [Gx](https://github.com/whyrusleeping/gx). In order to use it in your own project it is recommended that you:
42-
43-
```sh
44-
go get -u github.com/whyrusleeping/gx
45-
go get -u github.com/whyrusleeping/gx-go
46-
cd <your-project-repository>
47-
gx init
48-
gx import github.com/libp2p/go-libp2p-transport-upgrader
49-
gx install --global
50-
gx-go --rewrite
51-
```
52-
53-
Please check [Gx](https://github.com/whyrusleeping/gx) and [Gx-go](https://github.com/whyrusleeping/gx-go) documentation for more information.
54-
5544
## Example
5645

5746
Below is a simplified TCP transport implementation using the transport upgrader. In practice, you'll want to use [go-tcp-transport](https://github.com/libp2p/go-tcp-transport) (which has reuseport support).

0 commit comments

Comments
 (0)