From ff0b69f5c3e89f1e43f863cd24b6e66c767e49d2 Mon Sep 17 00:00:00 2001 From: Kir_Antipov Date: Sun, 21 Aug 2022 15:16:51 +0300 Subject: [PATCH] README update --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9dd3948..7bccc1b 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ jobs: github-token: ${{ secrets.GITHUB_TOKEN }} ``` -### 📖🦜 Unnecessary Verbose Example +### 🦜 Unnecessary Verbose Example Please, **do not** consider the following example as something you should use. `mc-publish` was made to be as zero-configy as possible, you just do not need all this. It's here to show you most of the available inputs in the form of an actual configuration. It not only hurts me on a spiritual level to see configurations with hardcoded values that could be automatically resolved, but sometimes people copy-paste inputs that will break their workflows, e.g., I saw someone trying to use `github-discussion: Announcements` in repo that had neither "Announcements" discussion category, nor discussions in general. [Occam's Razor](https://en.wikipedia.org/wiki/Occam%27s_razor) in action - if you don't see a reason to use an input, just don't use it. With all that said, let's get back to our unnecessary verbose example: