-
Notifications
You must be signed in to change notification settings - Fork 112
docs: improve README.md #950
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
5364cee
docs readme
Wwwsylvia 2b5efca
draft readme
Wwwsylvia 1043ae6
update
Wwwsylvia ff3c055
todo in targets.md
Wwwsylvia 577399c
docs readme
Wwwsylvia 40001ed
refine README
Wwwsylvia 22441bf
minor updates
Wwwsylvia fc4b519
wording
Wwwsylvia 8b4771a
explain tag moving
Wwwsylvia 9392b7e
refactor
Wwwsylvia f245a47
bullet points
Wwwsylvia 4a4b618
fix typo
Wwwsylvia cac45d6
refactored
Wwwsylvia e93bdfb
format
Wwwsylvia 487d267
space
Wwwsylvia 9a4fa85
Merge branch 'main' into improve_readme
Wwwsylvia File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,58 +1,66 @@ | ||
| # ORAS Go library | ||
|
|
||
| [](https://github.com/oras-project/oras-go/actions/workflows/build.yml?query=workflow%3Abuild+event%3Apush+branch%3Amain) | ||
| [](https://codecov.io/gh/oras-project/oras-go) | ||
| [](https://goreportcard.com/report/oras.land/oras-go/v2) | ||
| [](https://pkg.go.dev/oras.land/oras-go/v2) | ||
|
|
||
| <p align="left"> | ||
| <a href="https://oras.land/"><img src="https://oras.land/img/oras.svg" alt="banner" width="100px"></a> | ||
| <a href="https://oras.land/"><img src="https://oras.land/img/oras.svg" alt="ORAS logo" width="100px"></a> | ||
| </p> | ||
|
|
||
| ## Project status | ||
| `oras-go` is a Go library for managing OCI artifacts, compliant with the [OCI Image Format Specification](https://github.com/opencontainers/image-spec) and the [OCI Distribution Specification](https://github.com/opencontainers/distribution-spec). It provides unified APIs for pushing, pulling, and managing artifacts across OCI-compliant registries, local file systems, and in-memory stores. | ||
|
|
||
| ### Versioning | ||
| > [!Note] | ||
| > 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.23` and `1.24`). | ||
|
|
||
| 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. | ||
| ## Getting Started | ||
|
|
||
| ### v2: stable | ||
| ### Concepts | ||
|
|
||
| [](https://github.com/oras-project/oras-go/actions/workflows/build.yml?query=workflow%3Abuild+event%3Apush+branch%3Amain) | ||
| [](https://codecov.io/gh/oras-project/oras-go) | ||
| [](https://goreportcard.com/report/oras.land/oras-go/v2) | ||
| [](https://pkg.go.dev/oras.land/oras-go/v2) | ||
| Gain insights into the fundamental concepts: | ||
|
|
||
| The version `2` is actively developed in the [`main`](https://github.com/oras-project/oras-go/tree/main) branch with all new features. | ||
| - [Modeling Artifacts](docs/Modeling-Artifacts.md) | ||
| - [Targets and Content Stores](docs/Targets.md) | ||
|
|
||
| > [!Note] | ||
| > 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.23` and `1.24`). | ||
| ### Quickstart | ||
|
|
||
| Follow the step-by-step tutorial to use `oras-go` v2: | ||
|
|
||
| - [Quickstart: Managing OCI Artifacts with `oras-go` v2](docs/tutorial/quickstart.md) | ||
|
|
||
| ### Examples | ||
|
|
||
| Examples for common use cases can be found below: | ||
| Check out sample code for common use cases: | ||
|
|
||
| - [Copy examples](https://pkg.go.dev/oras.land/oras-go/v2#pkg-examples) | ||
| - [Registry interaction examples](https://pkg.go.dev/oras.land/oras-go/v2/registry#pkg-examples) | ||
| - [Repository interaction examples](https://pkg.go.dev/oras.land/oras-go/v2/registry/remote#pkg-examples) | ||
| - [Authentication examples](https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/auth#pkg-examples) | ||
| - [Artifact copying](https://pkg.go.dev/oras.land/oras-go/v2#pkg-examples) | ||
| - [Registry operations](https://pkg.go.dev/oras.land/oras-go/v2/registry#pkg-examples) | ||
| - [Repository operations](https://pkg.go.dev/oras.land/oras-go/v2/registry/remote#pkg-examples) | ||
| - [Authentication](https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/auth#pkg-examples) | ||
| - [Credentials management](https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#pkg-examples) | ||
|
|
||
| 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`. | ||
| The Go Reference for the `main` branch is available [here](https://pkg.go.dev/oras.land/oras-go/v2@main). | ||
| Find more API examples at [pkg.go.dev](https://pkg.go.dev/oras.land/oras-go/v2). | ||
|
|
||
| To migrate from `v1` to `v2`, see [MIGRATION_GUIDE.md](./MIGRATION_GUIDE.md). | ||
|
|
||
| ### v1: stable | ||
| ## Versioning | ||
|
|
||
| This project follows [Semantic Versioning](https://semver.org/) (`MAJOR`.`MINOR`.`PATCH`), with `MAJOR` for breaking changes, `MINOR` for backward-compatible features, and `PATCH` for backward-compatible fixes. | ||
|
|
||
| ## Previous Major Versions | ||
|
|
||
| ### v1 (maintenance) | ||
|
|
||
| [](https://github.com/oras-project/oras-go/actions/workflows/build.yml?query=workflow%3Abuild+event%3Apush+branch%3Av1) | ||
| [](https://goreportcard.com/report/oras.land/oras-go) | ||
| [](https://pkg.go.dev/oras.land/oras-go) | ||
|
|
||
| As there are various stable projects depending on the ORAS Go library `v1`, the | ||
| [`v1`](https://github.com/oras-project/oras-go/tree/v1) branch | ||
| is maintained for API stability, dependency updates, and security patches. | ||
| All `v1.*` releases are based upon this branch. | ||
|
|
||
| Since `v1` is in a maintenance state, you are highly encouraged | ||
| to use releases with major version `2` for new features. | ||
|
|
||
| ## Docs | ||
| The [`v1`](https://github.com/oras-project/oras-go/tree/v1) branch is maintained for dependency updates and security fixes only. All feature development happens in the [`main`](https://github.com/oras-project/oras-go/tree/main) branch. | ||
|
|
||
| - [oras.land/client_libraries/go](https://oras.land/docs/Client_Libraries/go): Documentation for the ORAS Go library | ||
| - [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. | ||
| To migrate from `v1` to `v2`, see [MIGRATION_GUIDE.md](MIGRATION_GUIDE.md). | ||
|
|
||
| ## Code of Conduct | ||
| ## Community | ||
|
|
||
| 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. | ||
| - Code of Conduct: [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) | ||
| - Security Policy: [SECURITY.md](SECURITY.md) | ||
| - Reviewing Guide: [Reviewing Guide](https://github.com/oras-project/community/blob/main/REVIEWING.md) | ||
| - Slack: [`#oras`](https://cloud-native.slack.com/archives/CJ1KHJM5Z) channel on CNCF Slack | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # `oras-go` v2 Documentation | ||
|
|
||
| This directory contains the fundamentals and a quickstart tutorial for `oras-go` v2. | ||
|
|
||
| ## Fundamentals | ||
|
|
||
| It is highly recommended to read the following documentation in order: | ||
|
|
||
| - [Modeling Artifacts](./Modeling-Artifacts.md) | ||
| - [Targets and Content Stores in `oras-go` v2](./Targets.md) | ||
|
|
||
| ## Quickstart Tutorial | ||
|
|
||
| - [Quickstart: Managing OCI Artifacts with `oras-go` v2](./tutorial/quickstart.md) | ||
|
|
||
| For more information about the ORAS project, visit the [ORAS website](https://oras.land/). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.