docs: README

This commit is contained in:
문성하 2025-02-02 22:14:31 +09:00
parent 02897d02f5
commit 57f02c5066
No known key found for this signature in database

View File

@ -1,8 +1,8 @@
[![GitHub release](https://img.shields.io/github/release/docker/setup-qemu-action.svg?style=flat-square)](https://github.com/docker/setup-qemu-action/releases/latest)
<!-- [![GitHub release](https://img.shields.io/github/release/docker/setup-qemu-action.svg?style=flat-square)](https://github.com/docker/setup-qemu-action/releases/latest)
[![GitHub marketplace](https://img.shields.io/badge/marketplace-docker--setup--qemu-blue?logo=github&style=flat-square)](https://github.com/marketplace/actions/docker-setup-qemu)
[![CI workflow](https://img.shields.io/github/actions/workflow/status/docker/setup-qemu-action/ci.yml?branch=master&label=ci&logo=github&style=flat-square)](https://github.com/docker/setup-qemu-action/actions?workflow=ci)
[![Test workflow](https://img.shields.io/github/actions/workflow/status/docker/setup-qemu-action/test.yml?branch=master&label=test&logo=github&style=flat-square)](https://github.com/docker/setup-qemu-action/actions?workflow=test)
[![Codecov](https://img.shields.io/codecov/c/github/docker/setup-qemu-action?logo=codecov&style=flat-square)](https://codecov.io/gh/docker/setup-qemu-action)
[![Codecov](https://img.shields.io/codecov/c/github/docker/setup-qemu-action?logo=codecov&style=flat-square)](https://codecov.io/gh/docker/setup-qemu-action) -->
## About
@ -12,11 +12,12 @@ GitHub Action to install [QEMU](https://github.com/qemu/qemu) static binaries.
___
* [Usage](#usage)
* [Customizing](#customizing)
* [inputs](#inputs)
* [outputs](#outputs)
* [Contributing](#contributing)
- [About](#about)
- [Usage](#usage)
- [Customizing](#customizing)
- [inputs](#inputs)
- [outputs](#outputs)
- [Contributing](#contributing)
## Usage
@ -46,6 +47,8 @@ The following inputs can be used as `step.with` keys:
| `image` | String | [`tonistiigi/binfmt:latest`](https://hub.docker.com/r/tonistiigi/binfmt/tags) | QEMU static binaries Docker image |
| `platforms` | String | `all` | Platforms to install (e.g., `arm64,riscv64,arm`) |
| `cache-image` | Bool | `true` | Cache binfmt image to GitHub Actions cache backend |
| `cache-image-path` | String | `` | Local path to store the binfmt image. Using this enables local caching instead of GitHub Actions cache.
Note: The "latest" tag won't auto-update - delete the cached file to fetch updates. |
### outputs