From f51e306cda494845ebaafcdcefee755cc19000f4 Mon Sep 17 00:00:00 2001
From: Joop Schilder <jnmschilder@protonmail.com>
Date: Thu, 22 Apr 2021 19:30:58 +0200
Subject: [PATCH] Add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2d5caf8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+# ASRock Memory QVL scraper
+
+Utility written in PHP 8.0 that scrapes a Memory QVL from the ASRock webpage and makes it searchable. It performs some
+nifty tricks such as inferring the amount of RAM modules in a kit based on module size and module number. There's a
+decorator enabled in [bin/app.php] which adds a hyperlink to the Tweakers.net pricewatch to the output. 
+
+There are two output modes available; csv and json. See [bin/app.php] for an example.