From f82f22f96ac362d287f8063da3043f208e1c85f5 Mon Sep 17 00:00:00 2001
From: TSR Berry <20988865+TSRBerry@users.noreply.github.com>
Date: Thu, 15 Dec 2022 17:00:02 +0100
Subject: [PATCH] Add GenerateArrays overview to README.md

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.md b/README.md
index 351f92b..61c5036 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,33 @@
 # Ryujinx.CustomTasks
 
 A collection of custom MSBuild tasks.
+
+## How do I add this Nuget package?
+
+Make sure to include the package with `PrivateAssets` set to `all`.
+
+```cs
+<PackageReference Include="Ryujinx.CustomTasks" Version="1.0.0" PrivateAssets="all" />
+```
+
+## Tasks
+
+### GenerateArrays
+
+This task scans source files for StructArray (i.e. `Array16<byte>`) types and generates them.
+
+#### Input properties:
+
+- `ArrayNamespace`: Namespace to be used by generated files.
+  - Required
+
+- `ArrayOutputPath`: Directory used to save the generated files in.
+  - Required
+
+- `ArrayInputFiles`: List of files to be searched for StructArray types.
+  - Required
+  - Default: All source files of the current project.
+
+#### Output properties:
+
+- `ArrayOutputFiles`: List of files generated by this task.