github.com/bytedance/gopkg@v0.0.0-20240514070511-01b2cbcf35e1/README.md (about)

     1  # gopkg
     2  
     3  [![Go Reference](https://pkg.go.dev/badge/github.com/bytedance/gopkg.svg)](https://pkg.go.dev/github.com/bytedance/gopkg)
     4  
     5  `gopkg` is a universal utility collection for Go, it complements offerings such as Boost, Better std, Cloud tools.
     6  
     7  ## Table of Contents
     8  
     9  - [Introduction](#Introduction)
    10  - [Catalogs](#Catalogs)
    11  - [Releases](#Releases)
    12  - [How To Use](#How-To-Use)
    13  - [License](#License)
    14  
    15  ## Introduction
    16  
    17  `gopkg` is a universal utility collection for Go, it complements offerings such as Boost, Better std, Cloud tools. It is migrated from the internal code base at ByteDance and has been extensively adopted in production.
    18  
    19  We depend on the same code(this repo) in our production environment.
    20  
    21  ## Catalogs
    22  
    23  * [cache](https://github.com/bytedance/gopkg/tree/main/cache): Caching Mechanism
    24  * [cloud](https://github.com/bytedance/gopkg/tree/main/cloud): Cloud Computing Design Patterns
    25  * [collection](https://github.com/bytedance/gopkg/tree/main/collection): Data Structures
    26  * [lang](https://github.com/bytedance/gopkg/tree/main/lang): Enhanced Standard Libraries
    27  * [util](https://github.com/bytedance/gopkg/tree/main/util): Utilities Useful across Domains
    28  
    29  ## Releases
    30  
    31  `gopkg` recommends users to "live-at-head" (update to the latest commit from the main branch as often as possible).
    32  We develop at `develop` branch and will only merge to `main` when `develop` is stable.
    33  
    34  ## How To Use
    35  
    36  You can use `go get -u github.com/bytedance/gopkg@main` to get or update `gopkg`.
    37  
    38  ## License
    39  
    40  `gopkg` is licensed under the terms of the Apache license 2.0. See [LICENSE](LICENSE) for more information.