Skip to content

Commit 1e609f1

Browse files
committed
README tweaks
1 parent 7641d2d commit 1e609f1

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# net
22

33
This library provides `net.Dial` and `net.Listen` functions
4-
for `GOOS=wasip1`. It uses the WasmEdge sockets extension to WASI
5-
preview 1.
4+
for `GOOS=wasip1`
65

76
Applications built with this library are compatible with WasmEdge
87
and [stealthrocket/wasi-go](https://github.com/stealthrocket/wasi-go).
98

109
## Dialing
1110

1211
The library will automatically configure the default HTTP transport
13-
to use the `Dial` function from this library. To make outbound HTTP
14-
connections you just need the following import somewhere:
12+
to use the `Dial` function from this library
13+
14+
To make outbound HTTP connections you just need the following import somewhere:
1515

1616
```go
1717
import _ "github.com/stealthrocket/net"
@@ -43,7 +43,7 @@ func main() {
4343
}
4444
```
4545

46-
For example, to connect to Redis:
46+
and to connect to Redis:
4747

4848
```go
4949
import (
@@ -90,15 +90,13 @@ for a hostname.
9090
### getaddrinfo
9191

9292
The `sock_getaddrinfo` host function is used to implement name resolution.
93-
This requires WasmEdge, or a WasmEdge compatible WASI layer
94-
(e.g. [wasi-go](http://github.com/stealthrocket/wasi-go)).
9593

9694
When using this method, the standard library resolver **will not work**. You
97-
_cannot_ use `net.DefaultResolver`, `net.LookupIP`, etc. with this approach
95+
cannot use `net.DefaultResolver`, `net.LookupIP`, etc. with this approach
9896
because the standard library does not allow us to patch it with an alternative
9997
implementation.
10098

101-
Note that `sock_getaddrinfo` may block!
99+
Note that `sock_getaddrinfo` may block.
102100

103101
### Pure Go Resolver
104102

0 commit comments

Comments
 (0)