From bb3b327c51e4159ff16aa9e747b095d68f97f12d Mon Sep 17 00:00:00 2001 From: olemorud Date: Thu, 16 Mar 2023 11:20:50 +0100 Subject: [PATCH] [docs] Update README --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0ed3636..33aaa60 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # GCC problem matcher -Unstable release! - Creates annotations for warnings and errors in gcc builds. ## Inputs @@ -12,7 +10,13 @@ Creates annotations for warnings and errors in gcc builds. ## Example usage -Just add this line anywhere before running the build step. +Create annotations for builds done in the root directory + +```yaml + - uses: olemorud/gcc-problem-matcher@v1.0 +``` + +Create annotations for builds done in directory `/workspace/build/` ```yaml - uses: olemorud/gcc-problem-matcher@master