From 9a4355f8e1611f0799315a1543a3f0d8f632a7b1 Mon Sep 17 00:00:00 2001
From: olemorud <ole.kristian.morud@cern.ch>
Date: Tue, 14 Mar 2023 14:48:56 +0100
Subject: [PATCH] [docs] Update README

---
 README.md | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index f02be5b..e190972 100644
--- a/README.md
+++ b/README.md
@@ -2,11 +2,18 @@
 
 Creates annotations for warnings and errors in gcc builds.
 
+## Inputs
 
-## Usage
+### root
 
-Just add a single line before running the build step.
+**Optional** Base directory for build. For builds done in a subdirectory, this should match that directory, otherwise the pattern match will not be able to point to the correct file.
+
+## Example usage
+
+Just add this line anywhere before running the build step.
 
 ```yaml
     - uses: olemorud/gcc-problem-matcher@master
-```
+      with:
+        root: /workspace/build
+```
\ No newline at end of file