Update readme and meta

fwal · fwal · commit 7bd62c61fd4e · 2019-12-17T22:36:25.000+01:00
diff --git a/.github/swift.svg b/.github/swift.svg
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 18.1.1, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 width="106.1px" height="106.1px" viewBox="-252 343.9 106.1 106.1" enable-background="new -252 343.9 106.1 106.1"
+	 xml:space="preserve">
+<g>
+	<path fill="#F05138" d="M-145.9,373.3c0-1.1,0-2.1,0-3.2c-0.1-2.3-0.2-4.7-0.6-7c-0.4-2.3-1.1-4.5-2.2-6.6c-1.1-2.1-2.4-4-4.1-5.6
+		c-1.7-1.7-3.6-3-5.6-4.1c-2.1-1.1-4.3-1.8-6.6-2.2c-2.3-0.4-4.6-0.6-7-0.6c-1.1,0-2.1,0-3.2,0c-1.3,0-2.5,0-3.8,0h-28.1h-11.6
+		c-1.3,0-2.5,0-3.8,0c-1.1,0-2.1,0-3.2,0c-0.6,0-1.2,0-1.7,0.1c-1.7,0.1-3.5,0.2-5.2,0.5c-1.7,0.3-3.4,0.8-5,1.4
+		c-0.5,0.2-1.1,0.5-1.6,0.7c-1.6,0.8-3,1.8-4.4,2.9c-0.4,0.4-0.9,0.8-1.3,1.2c-1.7,1.7-3,3.6-4.1,5.6c-1.1,2.1-1.8,4.3-2.2,6.6
+		c-0.4,2.3-0.5,4.6-0.6,7c0,1.1,0,2.1,0,3.2c0,1.3,0,2.5,0,3.8v17.3v22.4c0,1.3,0,2.5,0,3.8c0,1.1,0,2.1,0,3.2
+		c0.1,2.3,0.2,4.7,0.6,7c0.4,2.3,1.1,4.5,2.2,6.6c1.1,2.1,2.4,4,4.1,5.6c1.7,1.7,3.6,3,5.6,4.1c2.1,1.1,4.3,1.8,6.6,2.2
+		c2.3,0.4,4.6,0.6,7,0.6c1.1,0,2.1,0,3.2,0c1.3,0,2.5,0,3.8,0h39.7c1.3,0,2.5,0,3.8,0c1.1,0,2.1,0,3.2,0c2.3-0.1,4.7-0.2,7-0.6
+		c2.3-0.4,4.5-1.1,6.6-2.2c2.1-1.1,4-2.4,5.6-4.1c1.7-1.7,3-3.6,4.1-5.6c1.1-2.1,1.8-4.3,2.2-6.6c0.4-2.3,0.6-4.6,0.6-7
+		c0-1.1,0-2.1,0-3.2c0-1.3,0-2.5,0-3.8v-39.7C-145.9,375.8-145.9,374.6-145.9,373.3z"/>
+	<path fill="#FFFFFF" d="M-168,409.4c0.1-0.4,0.2-0.8,0.3-1.2c4.4-17.5-6.3-38.3-24.5-49.2c8,10.8,11.5,23.9,8.4,35.3
+		c-0.3,1-0.6,2-1,3c-0.4-0.3-0.9-0.6-1.6-0.9c0,0-18.1-11.2-37.7-30.9c-0.5-0.5,10.5,15.7,22.9,28.8c-5.9-3.3-22.2-15.2-32.6-24.6
+		c1.3,2.1,2.8,4.2,4.4,6.1c8.6,11,19.9,24.5,33.4,34.9c-9.5,5.8-22.9,6.3-36.2,0c-3.3-1.5-6.4-3.4-9.3-5.5
+		c5.6,9,14.3,16.8,24.9,21.4c12.6,5.4,25.2,5.1,34.5,0.1l0,0c0,0,0.1,0,0.1-0.1c0.4-0.2,0.8-0.5,1.2-0.7c4.5-2.3,13.3-4.6,18.1,4.6
+		C-161.3,432.6-158.8,420.6-168,409.4C-168,409.4-168,409.4-168,409.4z"/>
+</g>
+</svg>
diff --git a/README.md b/README.md
@@ -1,2 +1,54 @@
-# setup-swift
-GitHub Action to setup Swift
+# Setup Swift
+<img src=".github/swift.svg" height="20">
+<img src="https://img.shields.io/badge/macOS-grey">
+<img src="https://img.shields.io/badge/Ubuntu-grey">
+
+GitHub Action to setup a Swift environment with a specific version. Works on both Ubuntu and macOS environments.
+
+## Usage
+
+To run the action with the latest swift version available, simply add the action as a step in your workflow:
+
+```yaml
+- uses: fwal/setup-swift@master
+```
+
+A version can be provided by setting the `swift-version` input:
+
+```yaml
+- uses: fwal/setup-swift@master
+  with:
+    swift-version: "5.1.0"
+```
+
+Works perfect together with matrixes: 
+
+```yaml
+name: Swift ${{ matrix.swift }} on ${{ matrix.os }}
+runs-on: ${{ matrix.os }}
+strategy:
+  matrix:
+    os: [ubuntu-latest, macos-latest]
+    swift: ["5.1.0", "4.2.4"]
+steps:
+- uses: fwal/setup-swift@master
+  with:
+    swift-version: ${{ matrix.swift }}
+```
+
+## Note about versions
+
+This project uses strict semantic versioning to determine what version of Swift to configure. This differs slightly from the official convention used by Swift.
+
+For example, Swift is available as version `5.1` but this will be interpreted as a version _range_ of `5.1.X` where `X` is the latest patch version available for that major and minor version.
+
+
+In other words specifying...
+- `"5.1.0"` will resolve to version `5.1`
+- `"5.1"` will resolve to latest patch version (aka `5.1.1`)
+- `"5"` will resolve to latest minor and patch version (aka `5.1.1`)
+
+
+## Legal
+Uses MIT license. 
+The Swift logo is a trademark of Apple Inc.
diff --git a/action.yml b/action.yml
@@ -1,5 +1,5 @@
 name: Setup Swift environment
-description: Setup a Swift environment using swiftenv
+description: Setup a Swift environment on Ubuntu or macOS 
 author: Frederik Wallner
 inputs:
   swift-version: 
@@ -9,3 +9,6 @@ inputs:
 runs:
   using: node12
   main: lib/main.js
+branding:
+  icon: 'command'  
+  color: 'orange'
