From a90d45f6426c4e61326b0583e8b142f55012ea1b Mon Sep 17 00:00:00 2001 From: Benoit Daloze Date: Sun, 5 Jan 2020 12:55:52 +0100 Subject: [PATCH] Improve the README --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c4bd3ef..7ddfb73 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,10 @@ This action downloads a prebuilt ruby and adds it to `$PATH`. -## Supported Versions +It is very efficient and takes about 5 seconds to download, extract and add the given Ruby to `$PATH`. +No extra packages need to be installed. + +### Supported Versions This action currently supports these versions of MRI, JRuby and TruffleRuby: @@ -18,7 +21,7 @@ for the always up-to-date list of available Ruby versions. Note that Ruby 2.3 and the OpenSSL version it needs (1.0.2) are both end-of-life, which means Ruby 2.3 is unmaintained and considered insecure. -## Platforms +### Supported Platforms The action works for the `ubuntu-16.04`, `ubuntu-18.04` and `macos-latest` GitHub-hosted runners. `windows-latest` is not yet supported. @@ -94,10 +97,6 @@ jobs: - run: ruby -v ``` -## Efficiency - -It takes about 5 seconds to setup the given Ruby. - ## Limitations * Currently does not work on Windows since the builder doesn't build on Windows.