diff --git a/README.md b/README.md index 17d272e..7ed7de7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ -Quick shortcut action for authenticating as the GitHub Actions bot through `git config`. +Quick shortcut action for identifying as the GitHub Actions bot through `git config`. # Inputs - **working-directory** (default: current): run `git config` in the specified directory - **global** (default: false): run `git config --global` instead of `git config` + +# Usage + +```yaml +- uses: alorel-actions/git-ident@v1 +``` diff --git a/action.yml b/action.yml index 69472bc..18e38f1 100644 --- a/action.yml +++ b/action.yml @@ -1,5 +1,5 @@ -name: GitHub Actions Bot git auth -description: Quick shortcut action for authenticating as the GitHub Actions bot through `git config`. +name: GitHub Actions Bot git identity +description: Quick shortcut action for identifying as the GitHub Actions bot through `git config` inputs: working-directory: description: run git config in the specified directory