From 5030b8d2bb67dbfa0df547eda52bf6f3e936dbc9 Mon Sep 17 00:00:00 2001
From: Art <4998038+Alorel@users.noreply.github.com>
Date: Mon, 18 Sep 2023 01:54:27 +0100
Subject: [PATCH] fix: Add usage instructions to README

---
 README.md  | 8 +++++++-
 action.yml | 4 ++--
 2 files changed, 9 insertions(+), 3 deletions(-)

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