github.com/opcr-io/oras-go/v2@v2.0.0-20231122155130-eb4260d8a0ae/README.md (about) 1 # ORAS Go library 2 3 ![ORAS](https://github.com/oras-project/oras-www/raw/main/docs/assets/images/oras.png) 4 5 ## Project status 6 7 ### Versioning 8 9 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. 10 11 ### v2: stable 12 13 [![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) 14 [![codecov](https://codecov.io/gh/oras-project/oras-go/branch/main/graph/badge.svg)](https://codecov.io/gh/oras-project/oras-go) 15 [![Go Report Card](https://goreportcard.com/badge/github.com/opcr-io/oras-go/v2)](https://goreportcard.com/report/github.com/opcr-io/oras-go/v2) 16 [![Go Reference](https://pkg.go.dev/badge/github.com/opcr-io/oras-go/v2.svg)](https://pkg.go.dev/github.com/opcr-io/oras-go/v2) 17 18 The version `2` is actively developed in the [`main`](https://github.com/oras-project/oras-go/tree/main) branch with all new features. 19 20 Examples for common use cases can be found below: 21 22 - [Copy examples](https://pkg.go.dev/github.com/opcr-io/oras-go/v2#pkg-examples) 23 - [Registry interaction examples](https://pkg.go.dev/github.com/opcr-io/oras-go/v2/registry#pkg-examples) 24 - [Repository interaction examples](https://pkg.go.dev/github.com/opcr-io/oras-go/v2/registry/remote#pkg-examples) 25 - [Authentication examples](https://pkg.go.dev/github.com/opcr-io/oras-go/v2/registry/remote/auth#pkg-examples) 26 27 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`. 28 The Go Reference for the `main` branch is available [here](https://pkg.go.dev/github.com/opcr-io/oras-go/v2@main). 29 30 To migrate from `v1` to `v2`, see [MIGRATION_GUIDE.md](./MIGRATION_GUIDE.md). 31 32 ### v1: stable 33 34 [![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) 35 [![Go Report Card](https://goreportcard.com/badge/github.com/opcr-io/oras-go)](https://goreportcard.com/report/github.com/opcr-io/oras-go) 36 [![Go Reference](https://pkg.go.dev/badge/github.com/opcr-io/oras-go.svg)](https://pkg.go.dev/github.com/opcr-io/oras-go) 37 38 As there are various stable projects depending on the ORAS Go library `v1`, the 39 [`v1`](https://github.com/oras-project/oras-go/tree/v1) branch 40 is maintained for API stability, dependency updates, and security patches. 41 All `v1.*` releases are based upon this branch. 42 43 Since `v1` is in a maintenance state, you are highly encouraged 44 to use releases with major version `2` for new features. 45 46 ## Docs 47 48 - [oras.land/client_libraries/go](https://oras.land/client_libraries/0_go/): Documentation for the ORAS Go library 49 - [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. 50 51 ## Code of Conduct 52 53 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.