From f6d2d81f83dd29d8c60318700d9265a05b6c5c68 Mon Sep 17 00:00:00 2001
From: John Speed Meyers <54914994+jspeed-meyers@users.noreply.github.com>
Date: Wed, 2 Mar 2022 08:27:35 -0500
Subject: [PATCH] Add documentation about Alpine type (#697)

Signed-off-by: John Speed Meyers <jsmeyers@chainguard.dev>
---
 pkg/types/alpine/README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 pkg/types/alpine/README.md

diff --git a/pkg/types/alpine/README.md b/pkg/types/alpine/README.md
new file mode 100644
index 0000000..60cce33
--- /dev/null
+++ b/pkg/types/alpine/README.md
@@ -0,0 +1,12 @@
+**Alpine Type Data Documentation**
+
+This document notes additional information (beyond that found in the Alpine schema) about the values associated with
+each field such as the format in which the data is stored and any necessary transformations.
+
+Further information about pkginfo fields and the .PKGINFO file can be found on the [Alpine documentation website](https://wiki.alpinelinux.org/wiki/Alpine_package_format#.PKGINFO).
+
+The value of the `publicKey` `content` field ought to be Base64-encoded.
+
+**How do you identify an object as an Alpine object?**
+
+The "Body" field will include an "AlpineModel" field.
-- 
GitLab