From 3125a78d413b53f366194649f294fc6e2204eae8 Mon Sep 17 00:00:00 2001
From: Danny McCormick <damccorm@microsoft.com>
Date: Wed, 17 Jul 2019 11:01:48 -0400
Subject: [PATCH] Update README.md

---
 README.md | 37 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 36 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 6ab8f70..c831843 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,39 @@
-# @actions/setup-ruby
+# setup-ruby
+
+This action sets up a ruby environment for use in actions by:
+
+- optionally installing a version of ruby and adding to PATH. Note that this action only uses versions of Ruby already installed in the cache. The action will fail if no matching versions are found.
+- registering problem matchers for error output
+
+# Usage
+
+See [action.yml](action.yml)
+
+Basic:
+```yaml
+actions:
+- uses: actions/setup-ruby@latest
+  with:
+    version: 2.x // Version range or exact version of a Ruby version to use, using semvers version range syntax.
+- run: ruby hello.rb
+```
+
+Matrix Testing:
+```yaml
+jobs:
+  build:
+    strategy:
+      matrix:
+        ruby: [ 2.x, 3.x ]
+    name: Ruby ${{ matrix.ruby }} sample
+    actions:
+      - name: Setup ruby
+        uses: actions/setup-ruby@latest
+        with:
+          version: ${{ matrix.ruby }}
+          architecture: x64
+      - run: ruby hello.rb
+```
 
 # License