fix: Add usage instructions to README

alorel-actions · Sep 18, 2023 · 5030b8d · 5030b8d
1 parent adac431
commit 5030b8d
Show file tree

Hide file tree

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