github.com/cristalhq/netx@v0.0.0-20221116164110-442313ef3309/README.md (about)

     1  # netx
     2  
     3  [![build-img]][build-url]
     4  [![pkg-img]][pkg-url]
     5  [![reportcard-img]][reportcard-url]
     6  [![coverage-img]][coverage-url]
     7  [![version-img]][version-url]
     8  
     9  Better `net` package for Go.
    10  
    11  ## Features
    12  
    13  * Simple API.
    14  * Dependency-free.
    15  * Clean and tested code.
    16  * Fully compatible with `net` package.
    17  
    18  See [GUIDE.md](https://github.com/cristalhq/netx/blob/main/GUIDE.md) for more details.
    19  
    20  ## Install
    21  
    22  Go version 1.17+
    23  
    24  ```
    25  go get github.com/cristalhq/netx
    26  ```
    27  
    28  ## Example
    29  
    30  ```go
    31  TODO
    32  ```
    33  
    34  Also see examples: [examples_test.go](https://github.com/cristalhq/netx/blob/main/example_test.go).
    35  
    36  ## Documentation
    37  
    38  See [these docs][pkg-url].
    39  
    40  ## License
    41  
    42  [MIT License](LICENSE).
    43  
    44  [build-img]: https://github.com/cristalhq/netx/workflows/build/badge.svg
    45  [build-url]: https://github.com/cristalhq/netx/actions
    46  [pkg-img]: https://pkg.go.dev/badge/cristalhq/netx
    47  [pkg-url]: https://pkg.go.dev/github.com/cristalhq/netx
    48  [reportcard-img]: https://goreportcard.com/badge/cristalhq/netx
    49  [reportcard-url]: https://goreportcard.com/report/cristalhq/netx
    50  [coverage-img]: https://codecov.io/gh/cristalhq/netx/branch/main/graph/badge.svg
    51  [coverage-url]: https://codecov.io/gh/cristalhq/netx
    52  [version-img]: https://img.shields.io/github/v/release/cristalhq/netx
    53  [version-url]: https://github.com/cristalhq/netx/releases