github.com/dtroyer-salad/og2/v2@v2.0.0-20240412154159-c47231610877/README.md (about) 1 # ORAS Go library 2 3 <p align="left"> 4 <a href="https://oras.land/"><img src="https://oras.land/img/oras.svg" alt="banner" width="100px"></a> 5 </p> 6 7 ## Project status 8 9 ### Versioning 10 11 The ORAS Go library follows [Semantic Versioning](https://semver.org/), where breaking changes are reserved for MAJOR releases, and MINOR and PATCH releases must be 100% backwards compatible. 12 13 ### v2: stable 14 15 [![Build Status](https://github.com/oras-project/oras-go/actions/workflows/build.yml/badge.svg?event=push&branch=main)](https://github.com/oras-project/oras-go/actions/workflows/build.yml?query=workflow%3Abuild+event%3Apush+branch%3Amain) 16 [![codecov](https://codecov.io/gh/oras-project/oras-go/branch/main/graph/badge.svg)](https://codecov.io/gh/oras-project/oras-go) 17 [![Go Report Card](https://goreportcard.com/badge/oras.land/oras-go/v2)](https://goreportcard.com/report/oras.land/oras-go/v2) 18 [![Go Reference](https://pkg.go.dev/badge/oras.land/oras-go/v2.svg)](https://pkg.go.dev/oras.land/oras-go/v2) 19 20 The version `2` is actively developed in the [`main`](https://github.com/oras-project/oras-go/tree/main) branch with all new features. 21 22 > [!Note] 23 > The `main` branch follows [Go's Security Policy](https://github.com/golang/go/security/policy) and supports the two latest versions of Go (currently `1.21` and `1.22`). 24 25 Examples for common use cases can be found below: 26 27 - [Copy examples](https://pkg.go.dev/oras.land/oras-go/v2#pkg-examples) 28 - [Registry interaction examples](https://pkg.go.dev/oras.land/oras-go/v2/registry#pkg-examples) 29 - [Repository interaction examples](https://pkg.go.dev/oras.land/oras-go/v2/registry/remote#pkg-examples) 30 - [Authentication examples](https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/auth#pkg-examples) 31 32 If you are seeking latest changes, you should use the [`main`](https://github.com/oras-project/oras-go/tree/main) branch (or a specific commit hash) over a tagged version when including the ORAS Go library in your project's `go.mod`. 33 The Go Reference for the `main` branch is available [here](https://pkg.go.dev/oras.land/oras-go/v2@main). 34 35 To migrate from `v1` to `v2`, see [MIGRATION_GUIDE.md](./MIGRATION_GUIDE.md). 36 37 ### v1: stable 38 39 [![Build Status](https://github.com/oras-project/oras-go/actions/workflows/build.yml/badge.svg?event=push&branch=v1)](https://github.com/oras-project/oras-go/actions/workflows/build.yml?query=workflow%3Abuild+event%3Apush+branch%3Av1) 40 [![Go Report Card](https://goreportcard.com/badge/oras.land/oras-go)](https://goreportcard.com/report/oras.land/oras-go) 41 [![Go Reference](https://pkg.go.dev/badge/oras.land/oras-go.svg)](https://pkg.go.dev/oras.land/oras-go) 42 43 As there are various stable projects depending on the ORAS Go library `v1`, the 44 [`v1`](https://github.com/oras-project/oras-go/tree/v1) branch 45 is maintained for API stability, dependency updates, and security patches. 46 All `v1.*` releases are based upon this branch. 47 48 Since `v1` is in a maintenance state, you are highly encouraged 49 to use releases with major version `2` for new features. 50 51 ## Docs 52 53 - [oras.land/client_libraries/go](https://oras.land/docs/Client_Libraries/go): Documentation for the ORAS Go library 54 - [Reviewing guide](https://github.com/oras-project/community/blob/main/REVIEWING.md): All reviewers must read the reviewing guide and agree to follow the project review guidelines. 55 56 ## Code of Conduct 57 58 This project has adopted the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for further details.