From 9d79ee9154247b7747e17aa5aef16086af065eb3 Mon Sep 17 00:00:00 2001
From: Johnson Shi <Johnson.Shi@microsoft.com>
Date: Fri, 22 Jul 2022 10:15:57 -0700
Subject: [PATCH] add README

Signed-off-by: Johnson Shi <Johnson.Shi@microsoft.com>
---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2041234
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# ORAS Tools
+
+Helper tools for [ORAS](https://oras.land).
+
+## Quick Start
+
+### Install
+
+To install, run the following commands.
+
+```bash
+curl -LO https://github.com/johnsonshi/oras-tools/releases/download/v0.0.1/oras-tools
+chmod +x oras-tools
+sudo mv oras-tools /usr/local/bin
+```
+
+## Commands
+
+### Delete
+
+Delete [ORAS artifacts](https://oras.land/#how-oras-works) from a registry.
+
+To delete an ORAS artifact (referenced by its hash `$digest`) in `$registry_url` and `$repository_name`:
+
+```bash
+./bin/oras-tools delete \
+  --username "$registry_username" \
+  --password "$registry_password" \
+  --registry "$registry_url" \
+  --repository "$repository_name" \
+  --digest "$digest"
+```