update readme

ryanwinter · Apr 17, 2021 · 1550662 · 1550662
1 parent fd1ad3a
commit 1550662
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 14 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,10 +1,10 @@
 name: CI
+
 on: # rebuild any PRs and main branch changes
   pull_request:
   push:
     branches:
       - master
-      - 'releases/*'
 
 jobs:
   build: # make sure build/ci work properly
@@ -13,6 +13,7 @@ jobs:
     - uses: actions/checkout@v2
     - run: npm install
     - run: npm run all
+
   test: # make sure the action works on a clean machine without building
     strategy:
       fail-fast: false

diff --git a/README.md b/README.md
@@ -2,15 +2,48 @@
 
 [![CI](https://github.com/ryanwinter/arm-none-eabi-gcc/workflows/CI/badge.svg)](https://github.com/ryanwinter/arm-none-eabi-gcc/actions)
 
-This action downloads and sets up arm-none-eabi-gcc, adding it to the PATH. It works on Windows, Linux and macOS.
+Install `arm-non-eabi-gcc` and add to the path. Supports Windows, Linux and macOS.
 
 ## Usage
 
+Add the following to your GitHub workflow:
+
 ```yaml
-steps:
-- name: arm-none-eabi-gcc
-  uses: ryanwinter/arm-none-eabi-gcc@master
-  with:
-    release: '10-2020-q4' # The arm-none-eabi-gcc release to use.
-- run: ...
+    steps:
+      - name: arm-none-eabi-gcc
+        uses: ryanwinter/arm-none-eabi-gcc@master
+        with:
+          release: '10-2020-q4' # The arm-none-eabi-gcc release to use.
+
+      - run: ...
 ```
+
+## Releases
+
+* 10-2020-q4
+* 9-2020-q2
+* 9-2019-q4
+* 8-2019-q3
+* 8-2018-q4
+* 7-2018-q2
+* 7-2017-q4
+* 6-2017-q2
+* 6-2017-q1
+* 6-2016-q4
+* 5-2016-q3
+* 5-2016-q2
+* 5-2016-q1
+* 5-2015-q4
+* 4.9-2015-q3
+* 4.9-2015-q2
+* 4.9-2015-q1
+* 4.9-2014-q4
+* 4.8-2014-q3
+* 4.8-2014-q2
+* 4.8-2014-q1
+* 4.7-2014-q2
+* 4.8-2013-q4
+* 4.7-2013-q3
+* 4.7-2013-q2
+* 4.7-2013-q1
+* 4.7-2012-q4
diff --git a/action.yml b/action.yml
@@ -1,11 +1,9 @@
-name: 'arm-none-eabi-gcc'
-description: 'Set up arm-none-eabi-gcc and add it to the PATH'
-author: 'Alberto Garcia Hierro <[email protected]>'
+name: 'GNU Arm Embedded Toolchain'
+description: 'Install arm-none-eabi-gcc'
+author: 'Ryan Winter'
 inputs:
   release:
-    description: 'GNU Embedded Toolchain for Arm release name, in the V-YYYY-qZ format (e.g. "9-2019-q4")'
-  directory:
-    description: 'Directory to unpack GCC to. Defaults to a temporary directory.'
+    description: 'GNU Arm Embedded Toolchain release name, in the V-YYYY-qZ format (e.g. "9-2019-q4")'
 runs:
   using: 'node12'
   main: 'dist/index.js'