From 6b63f22f63d4f786ca3221b380d6ad7637e43ea5 Mon Sep 17 00:00:00 2001
From: Gustavo Carreno <guscarreno@gmail.com>
Date: Thu, 9 Apr 2020 23:59:18 +0100
Subject: [PATCH] docs: More information on the README.md

---
 .github/workflows/workflow.yml |  2 +-
 README.md                      | 49 +++++++++++++++++++++++++++++++++-
 2 files changed, 49 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/workflow.yml b/.github/workflows/workflow.yml
index a912f51..7e76c2c 100644
--- a/.github/workflows/workflow.yml
+++ b/.github/workflows/workflow.yml
@@ -19,7 +19,7 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Install Lazarus
-      uses: gcarreno/setup-lazarus@v1.0.34
+      uses: gcarreno/setup-lazarus@v1.0.35
       with:
         lazarus-version: ${{ matrix.lazarus-versions }}
     - name: Build the Main Application
diff --git a/README.md b/README.md
index a07bf49..7ee94fa 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,50 @@
 # lazarus-with-github-actions
 
-Testing grounds for the GitHub action setup-lazarus
+Testing grounds for the GitHub action [setup-lazarus](https://github.com/gcarreno/setup-lazarus)
+
+**Note**: For supported Lazarus versions and the associated FPC version consult the link above.
+
+## Example usage
+
+```yaml
+steps:
+- uses: actions/checkout@v2
+- uses: gcarreno/setup-lazarus@v1
+  with:
+    lazarus-version: 'dist'
+- run: lazbuild YourTestProject.lpi
+- run: YourTestProject
+```
+
+## Matrix example usage
+
+```yaml
+name: build
+
+on:
+  pull_request:
+  push:
+    paths-ignore:
+    - "README.md"
+    branches:
+      - master
+      - releases/*
+
+jobs:
+  build:
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      matrix:
+        operating-system: [ubuntu-18.04,ubuntu-latest]
+        lazarus-versions: [dist, 2.0.6]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install Lazarus
+      uses: gcarreno/setup-lazarus@v1.0.34
+      with:
+        lazarus-version: ${{ matrix.lazarus-versions }}
+    - name: Build the test app
+      run: lazbuild "tests/testconsoleapplication.lpi"
+    - name: Run the test app
+      run: bin/testconsoleapplication "--all" "--format=plain"
+```