From 8c0a3268b6700159f079e3abbad85ee2dba52c93 Mon Sep 17 00:00:00 2001 From: Romain Lespinasse Date: Fri, 2 Apr 2021 16:14:40 +0200 Subject: [PATCH] docs: improve overview section --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f0e2e45..c7d6807 100644 --- a/README.md +++ b/README.md @@ -37,10 +37,14 @@ This GitHub Action will expose the slug/short values of [some GitHub environment Others Slug-ish commands are available

-- `SLUG_URL` on a variable to have a `slug` variable compliant to be used in an URL (Like `SLUG` but `.` is also replaced by `-`) -- `SHORT` on a variable will limit the string size to 8 characters (useful for _sha_ value) +- `SLUG_URL` on a variable to have a `slug` variable compliant to be used in an URL + - Like `SLUG` but `.` is also replaced by `-` +- `SHORT` on a variable will limit the string size to 8 characters + - Useful for _sha_ value - `_PART` on a variable will give a part of a variable defined by a key -_ `_CS` on others variables to keep the value case-sensitive + - Like `GITHUB_REPOSITORY_OWNER_PART` for the owner part of `GITHUB_REPOSITORY` +- `_CS` on others variables to keep the value case-sensitive + - Like `GITHUB_REF_SLUG_CS`