chore(docs): update

LironEr · Aug 19, 2023 · 0f7c6f3 · 0f7c6f3
1 parent 0d7dd61
commit 0f7c6f3
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git 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
@@ -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'