From b87c46f0cbc02d31081db63bac6d56ea01665487 Mon Sep 17 00:00:00 2001
From: Antoine Martin <dev@ayakael.net>
Date: Sun, 29 Dec 2024 14:44:31 -0500
Subject: [PATCH] README: initial

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3975f67
--- /dev/null
+++ b/README.md
@@ -0,0 +1,63 @@
+# pmayaports
+Upstream: https://ayakael.net/forge/pmayaports
+
+## Description
+
+This repository contains aports that are not yet merged in the official
+PostmarketOS repository or don’t adhere to pmOS polices. Packages are
+automatically built using CI. Once built, they are deployed to a Forgejo
+repository, making them available to apk.
+
+Branches are matched to PostmarketOS releases.
+
+## Repositories
+
+You can browse all the repositories at https://ayakael.net/forge/pmayaports
+Affixed to each repository description is the appropriate link for use in
+`/etc/apk/repositories`.
+
+#### Backports
+```
+https://ayakael.net/api/packages/forge/alpine/v24.12/pm-backports
+```
+
+Aports from the official pmOS repositories backported from master. This is only
+available and kept up-to-date on latest stable release.
+
+#### User
+```
+https://ayakael.net/api/packages/forge/alpine/edge/pm-user
+```
+
+Aports that have yet to be (or may never be) upstreamed to the official
+aports.
+
+
+## How to use
+Add security key of the apk repository to your /etc/apk/keys:
+
+```shell
+cd /etc/apk/keys
+curl -JO https://ayakael.net/api/packages/forge/alpine/key
+```
+Add repositories that you want to use (see above) to `/etc/apk/repositories`.
+
+## Support
+Generally, only the latest branch is kept up-to-date. That said, if an aport
+is broken on the latest release due to a dependency incompatibility, it will be
+kept up-to-date on the release it last works on.
+
+As these aports are built for my own application, I make no guarantees that
+they will work for you.
+
+## Contribution & bug reports
+If you wish to contribute to this aports collection, or wish to report a bug,
+you can do so on Codeberg here:
+https://codeberg.org/ayakael/pmayaports/issues
+
+For packages that are in backports, bug reports and merge requests
+should be done on Alpine's aports repo instance:
+https://gitlab.alpinelinux.org/alpine/aports
+
+## License
+This readme, abuilds and support scripts are licensed under MIT License.