github.com/go-playground/pkg/v5@v5.29.1/README.md (about)

     1  # pkg
     2  
     3  ![Project status](https://img.shields.io/badge/version-5.29.1-green.svg)
     4  [![Lint & Test](https://github.com/go-playground/pkg/actions/workflows/go.yml/badge.svg)](https://github.com/go-playground/pkg/actions/workflows/go.yml)
     5  [![Coverage Status](https://coveralls.io/repos/github/go-playground/pkg/badge.svg?branch=master)](https://coveralls.io/github/go-playground/pkg?branch=master)
     6  [![GoDoc](https://godoc.org/github.com/go-playground/pkg?status.svg)](https://pkg.go.dev/mod/github.com/go-playground/pkg/v5)
     7  ![License](https://img.shields.io/dub/l/vibe-d.svg)
     8  
     9  pkg extends the core Go packages with missing or additional functionality built in. All packages correspond to the std go package name with an additional suffix of `ext` to avoid naming conflicts.
    10  
    11  ## Motivation
    12  
    13  This is a place to put common reusable code that is not quite a library but extends upon the core library, or it's failings.
    14  
    15  ## Install
    16  
    17  `go get -u github.com/go-playground/pkg/v5`
    18  
    19  
    20  ## Highlights
    21  - Generic Doubly Linked List.
    22  - Result & Option types
    23  - Generic Mutex and RWMutex.
    24  - Bytes helper placeholders units eg. MB, MiB, GB, ...
    25  - Detachable context.
    26  - Retrier for helping with any fallible operation.
    27  - Proper RFC3339Nano definition.
    28  - unsafe []byte->string & string->[]byte helper functions.
    29  - HTTP helper functions and constant placeholders.
    30  - And much, much more.
    31  
    32  ## How to Contribute
    33  
    34  Make a pull request... can't guarantee it will be added, going to strictly vet what goes in.
    35  
    36  ## License
    37  
    38  <sup>
    39  Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
    40  2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
    41  </sup>
    42  
    43  <br>
    44  
    45  <sub>
    46  Unless you explicitly state otherwise, any contribution intentionally submitted
    47  for inclusion in this package by you, as defined in the Apache-2.0 license, shall be
    48  dual licensed as above, without any additional terms or conditions.
    49  </sub>