Skip to content
This repository has been archived by the owner on Apr 7, 2024. It is now read-only.

docs: add a brief introduction in README #83

Merged
merged 7 commits into from
Jul 14, 2023
Merged

docs: add a brief introduction in README #83

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
280d60c
doc: add a brief introduction in README
Wwwsylvia Jul 13, 2023
04c047d
remove empty line
Wwwsylvia Jul 13, 2023
b540d8f
revised
Wwwsylvia Jul 14, 2023
7162a7d
revise
Wwwsylvia Jul 14, 2023
f463566
fix format
Wwwsylvia Jul 14, 2023
4c36db2
minor format
Wwwsylvia Jul 14, 2023
97df607
reword
Wwwsylvia Jul 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
<a href="https://oras.land/"><img src="https://oras.land/img/oras.svg" alt="banner" width="100px"></a>
</p>

`oras-credentials-go` is a credential management library designed for [`oras-go`](https://github.com/oras-project/oras-go). It supports reading, saving, and removing credentials from Docker configuration files and external credential stores that follow the [Docker credential helper protocol](https://docs.docker.com/engine/reference/commandline/login/#credential-helper-protocol), while not handling credential encryption and decryption.
Wwwsylvia marked this conversation as resolved.
Show resolved Hide resolved

Once stable, this library will be merged into `oras-go`.

## Versioning

The `oras-credentials-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.
Expand Down