From 76a22821245df5080c88fb9c567335e88d000a6c Mon Sep 17 00:00:00 2001
From: redxef <federanko.manuel@gmail.com>
Date: Mon, 29 Aug 2022 22:54:28 +0200
Subject: [PATCH] Add readme.

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..deeefc1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+# concourse-oci-resource
+
+A resource type for oci image tarballs.
+
+## Source configuration
+
+```yaml
+resource_types:
+- name: oci-image
+  type: registry-image
+  source:
+    repository: redxef/concourse-oci-resource
+resources:
+- name: my-image
+  type: oci-image
+  source:
+    repository: redxef/concourse-oci-resource
+    tag: latest
+    username: ((registry.username))
+    password: ((registry.password))
+```
+
+- repository: *Required*. The URI of the image repository.
+- tag: *Optional*. *Default* `latest`. The tag of this image.
+- username: *Optional*. Username used to authenticate.
+- password: *Optional*. Password used to authenticate.
+
+## `check`
+
+Check if there is a new version represented with the given source
+configuration.
+
+## `in` receive a OCI tarball
+
+Creates the following files:
+
+- `./image.tar`: The image tarball.
+- `./digest`: A file containing the digest of the pulled image.
+- `./repository`: The repository name (the same as the source configuration).
+
+## `out` push an image to a repository
+
+Push the image to the repository and add tags.
+
+### Configuration
+
+```yaml
+- put: my-image
+  params:
+    additional_tags: path/to/tags/file
+```
+
+### Parameters
+
+- additional\_tags: *Optional*. The path to a file containing more tags.
+