Initial version 1.4.0

1 files changed, 32 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 000000000000..cd96f79ff470
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# php-gnupg-aur
+An [AUR] package build for PHP's [gnupg] extension.
+
+## Building
+You can of course build this package using [makepkg], but the recommended way
+of building this package is using [Docker].  This can be done like so:
+
+```bash
+docker build --tag php-gnupg-aur .
+docker run --rm --volume "$(pwd):/package" php-gnupg-aur
+```
+
+Alternatively, using [Docker Compose]:
+
+```bash
+docker-compose run build
+```
+
+This will start create a docker image tagged as php-gnupg-aur and build the
+package inside the container.  As a result you should get the built package in
+your current directory.
+
+## License
+php-gnupg-aur is licensed under the MIT license.  See [LICENSE] for the full
+license text.
+
+[AUR]: https://aur.archlinux.org/
+[gnupg]: https://pecl.php.net/package/gnupg
+[makepkg]: https://wiki.archlinux.org/index.php/Makepkg
+[Docker]: https://www.docker.com/
+[Docker Compose]: https://docs.docker.com/compose/
+[LICENSE]: https://github.com/nubs/php-gnupg-aur/blob/master/LICENSE