From a58bb309962287b1a923003d7d852fd2cc013a04 Mon Sep 17 00:00:00 2001
From: Gabriel Tkacz <55806524+gtkacz@users.noreply.github.com>
Date: Wed, 11 Sep 2024 18:26:27 -0300
Subject: [PATCH] Update README.md

---
 README.md | 24 ++++++++++--------------
 1 file changed, 10 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 1af8d92..96235dd 100644
--- a/README.md
+++ b/README.md
@@ -24,18 +24,18 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - name: Run Vulture
-      uses: gtkacz/vulture-action@v1
+      uses: gtkacz/vulture-action@1.0.0
       with:
         args: '. --min-confidence 70 --exclude "tests,docs" --verbose'
 ```
 
 ## Inputs
 
-This action accepts a single input:
+This action accepts three inputs:
 
-- `args`: Command line arguments to pass to Vulture (required, default: '.')
-
-You can use any valid Vulture CLI arguments in this input. For a full list of available options, refer to the [Vulture documentation](https://github.com/jendrikseipp/vulture#usage).
+- `src`: Source to run vulture. Default: '.'.
+- `args`: Arguments passed to Vulture. Use `vulture --help` to see available options or refer to the [Vulture documentation](https://github.com/jendrikseipp/vulture#usage).
+- `version`: The version of vulture to use, e.g. "==2.11.0"
 
 ## Examples
 
@@ -45,7 +45,7 @@ Scan the entire repository with default settings:
 
 ```yaml
 - name: Run Vulture
-  uses: gtkacz/vulture-action@v1
+  uses: gtkacz/vulture-action@1.0.0
 ```
 
 ### Custom Configuration
@@ -54,7 +54,7 @@ Scan with a minimum confidence of 80%, excluding specific directories, and using
 
 ```yaml
 - name: Run Vulture
-  uses: gtkacz/vulture-action@v1
+  uses: gtkacz/vulture-action@1.0.0
   with:
     args: '. --min-confidence 80 --exclude "tests,docs,build" --verbose'
 ```
@@ -67,7 +67,7 @@ Scan only the `src` directory:
 - name: Run Vulture
   uses: gtkacz/vulture-action@v1
   with:
-    args: 'src'
+    src: 'src'
 ```
 
 ### Using a Configuration File
@@ -76,15 +76,11 @@ If you have a `vulture_config.py` file in your repository:
 
 ```yaml
 - name: Run Vulture
-  uses: gtkacz/vulture-action@v1
+  uses: gtkacz/vulture-action@1.0.0
   with:
-    args: '. --make-whitelist vulture_config.py'
+    args: '--make-whitelist vulture_config.py'
 ```
 
-## Customizing the Action
-
-You can customize the action by modifying the `action.yml` file. The current implementation allows for maximum flexibility, but you might want to add specific inputs or steps based on your project's needs.
-
 ## Contributing
 
 Contributions to improve this GitHub Action are welcome! Please feel free to submit issues or pull requests.