From 3808f6e3216fa10d91e1e0276e4bb800ca600659 Mon Sep 17 00:00:00 2001
From: ksew1 <95349104+ksew1@users.noreply.github.com>
Date: Mon, 13 Jan 2025 13:16:50 +0100
Subject: [PATCH] Add README.md (#8)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

**Stack**:
- #8 ⬅
- #7
- #6
- #5


⚠️ *Part of a stack created by [spr](https://github.com/ejoffe/spr). Do
not merge manually using the UI - doing so may have unexpected results.*
---
 README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

diff --git a/README.md b/README.md
index e69de29..16678eb 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,50 @@
+# asdf-cairo-coverage
+
+[cairo-coverage] plugin for the [asdf] version manager.
+
+## Install
+
+This plugin needs `bash`, `curl`, `tar` and other generic POSIX utilities.
+Everything should be included by default on your system.
+
+```shell
+asdf plugin add cairo-coverage https://github.com/software-mansion/asdf-cairo-coverage.git
+```
+
+## Use
+
+Show all installable versions:
+
+```shell
+asdf list-all cairo-coverage
+```
+
+Install latest version:
+
+```shell
+asdf install cairo-coverage latest
+```
+
+Install specific version:
+
+```shell
+asdf install cairo-coverage 0.2.0
+```
+
+Set a version globally (in your `~/.tool-versions` file):
+
+```shell
+asdf global cairo-coverage latest
+```
+
+Now cairo-coverage commands are available:
+
+```shell
+cairo-coverage --version
+```
+
+Check [asdf](https://github.com/asdf-vm/asdf) readme for more instructions on how to install & manage versions.
+
+[asdf]: https://asdf-vm.com
+
+[cairo-coverage]: https://github.com/software-mansion/cairo-coverage