From 0f7c6f3b0752e31d557c98bd588b7f2ff3bb13b2 Mon Sep 17 00:00:00 2001 From: LironEr Date: Sat, 19 Aug 2023 17:23:13 +0300 Subject: [PATCH] chore(docs): update --- README.md | 6 +++++- action.yml | 4 ++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1c71636..46792de 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,20 @@ # BundleMon GitHub Action +Easily use [BundleMon](https://github.com/LironEr/bundlemon) to monitor your bundle size on every commit from GitHub Actions + ## Inputs | Name | Required | Default | Description | | ----------------- | :------: | -------------- | ------------------------------------------------------------------ | -| bundlemon-args | - | | Optional args for BundleMon cli. Example: --subProject "some-name" | +| bundlemon-args | - | | Optional args for [BundleMon cli](https://github.com/LironEr/bundlemon#cli-usage). Example: --subProject "some-name" | | bundlemon-version | - | Latest version | BundleMon cli version | | working-directory | - | | The working directory | ## Usage +BundleMon config must be present to run this action, See [BundleMon setup](https://github.com/LironEr/bundlemon#setup) for more info. + ```yaml name: Build diff --git a/action.yml b/action.yml index 4b4b1af..7504278 100644 --- a/action.yml +++ b/action.yml @@ -1,5 +1,5 @@ -name: 'bundlemon' -description: 'Run BundleMon CLI to check for bundle size changes' +name: 'BundleMon' +description: 'A free open-source tool that helps you to monitor your bundle size on every commit and alerts you on changes.' author: 'LironEr' branding: icon: 'activity'