storj.io/uplink@v1.13.0/README.md (about)

     1  <picture>
     2    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/storj/.github/main/assets/storj-logo-full-white.png">
     3    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/storj/.github/main/assets/storj-logo-full-color.png">
     4    <img alt="Storj logo" src="https://raw.githubusercontent.com/storj/.github/main/assets/storj-logo-full-color.png" width="140">
     5  </picture>
     6  
     7  # Libuplink
     8  
     9  Go library for Storj V3 Network.
    10  
    11  [![Go Report Card](https://goreportcard.com/badge/storj.io/uplink)](https://goreportcard.com/report/storj.io/uplink)
    12  [![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](https://pkg.go.dev/storj.io/uplink)
    13  
    14  Storj is building a decentralized cloud storage network.
    15  [Check out our white paper for more info!](https://storj.io/whitepaper)
    16  
    17  ----
    18  
    19  Storj is an S3-compatible platform and suite of decentralized applications that
    20  allows you to store data in a secure and decentralized manner. Your files are
    21  encrypted, broken into little pieces and stored in a global decentralized
    22  network of computers. Luckily, we also support allowing you (and only you) to
    23  retrieve those files!
    24  
    25  [![Introducing Storj DCS—Decentralized Cloud Storage for Developers](https://img.youtube.com/vi/JgKdBRIyIps/hqdefault.jpg)](https://www.youtube.com/watch?v=JgKdBRIyIps)
    26  
    27  ### Installation
    28  
    29  ```
    30  go get storj.io/uplink
    31  ```
    32  
    33  ### Example
    34  
    35  Ready to use example can be found here: [examples/walkthrough/main.go](examples/walkthrough/main.go)
    36  
    37  Provided example requires Access Grant as an input parameter. Access Grant can be obtained from Satellite UI. [See our documentation](https://docs.storj.io/dcs/getting-started/quickstart-uplink-cli/uploading-your-first-object/create-first-access-grant).
    38  
    39  ### A Note about Versioning
    40  
    41  Our versioning in this repo is intended to primarily support the expectations of the
    42  [Go modules](https://blog.golang.org/using-go-modules) system, so you can expect that
    43  within a major version release, backwards-incompatible changes will be avoided at high
    44  cost.
    45  
    46  # Documentation
    47  
    48  - [Go Doc](https://pkg.go.dev/storj.io/uplink)
    49  - [Libuplink Walkthrough](https://github.com/storj/storj/wiki/Libuplink-Walkthrough)
    50  
    51  # Language bindings
    52  
    53  - [Uplink-C](https://github.com/storj/uplink-c)
    54  
    55  # License
    56  
    57  This library is distributed under the
    58  [MIT license](https://opensource.org/licenses/MIT) (also known as the Expat license).
    59  
    60  # Support
    61  
    62  If you have any questions or suggestions please reach out to us on [our community forum](https://forum.storj.io/) or file a support ticket at https://support.storj.io.