From b78432ece412990f15cbb0e9c40c3e264574ef87 Mon Sep 17 00:00:00 2001
From: Markus Pesch <markus.pesch@cryptic.systems>
Date: Fri, 16 Dec 2022 15:58:04 +0100
Subject: [PATCH] fix: add README

---
 .gitignore |  1 +
 README.md  | 34 ++++++++++++++++++++++++++++++++++
 2 files changed, 35 insertions(+)
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
index 3814e41..e4f3cb5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,3 +3,4 @@
 !.gitignore
 !.editorconfig
 !.SRCINFO
+!README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c23b589
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# mint-backgrounds
+
+[![https://img.shields.io/aur/version/mint-backgrounds](https://img.shields.io/aur/version/mint-backgrounds)](https://aur.archlinux.org/packages/mint-backgrounds)
+[![https://img.shields.io/aur/license/mint-backgrounds](https://img.shields.io/aur/license/mint-backgrounds)](https://aur.archlinux.org/packages/mint-backgrounds)
+[![https://img.shields.io/aur/maintainer/mint-backgrounds](https://img.shields.io/aur/maintainer/mint-backgrounds)](https://aur.archlinux.org/packages/mint-backgrounds)
+[![https://img.shields.io/aur/last-modified/mint-backgrounds](https://img.shields.io/aur/last-modified/mint-backgrounds)](https://aur.archlinux.org/packages/mint-backgrounds)
+
+This repository contains the source code to build the Arch Linux package
+`mint-backgrounds`.
+
+The package can be created and installed locally via `makepkg`. Alternatively,
+it can be installed from the
+[AUR](https://aur.archlinux.org/packages/mint-backgrounds) using an AUR helper
+such as `yay`.
+
+## makepkg
+
+Clone the repository from one of the mirrors and move into the cloned git
+repository. Execute `makepkg --install` to build the and install the package.
+
+```bash
+git clone <URL>
+cd mint-backgrounds
+makepkg --install
+```
+
+## yay
+
+Make sure that yay is installed. Run yay to build and install the
+mint-backgrounds package.
+
+```bash
+yay --sync --aur mint-backgrounds
+```