update readme

Author: imurashka

README.md

@@ -4,14 +4,14 @@ Smart resolution of git details. Validates inputs, resolves SHA from branch/ref,
 
 ## Inputs
 
-| Input | Description | Required | Default |
-| --- | --- | --- | --- |
-| `repository` | Repository in format owner/repo | **Yes** | |
-| `token` | GitHub token with repo access | **Yes** | |
-| `branch` | Branch name. If provided, verified against SHA/Ref. | No | |
-| `sha` | Commit SHA. If provided, used as verification target. | No | |
-| `ref` | Git ref (e.g., refs/heads/main). If provided, verified. | No | |
-| `ref_name` | Reference name override | No | |
+| Input | Description | Required |
+| --- | --- | --- |
+| `repository` | Repository in format owner/repo | **Yes** |
+| `token` | GitHub token with repo access | **Yes** |
+| `branch` | Branch name. If provided, verified against SHA/Ref. | No |
+| `sha` | Commit SHA. If provided, used as verification target. | No |
+| `ref` | Git ref (e.g., refs/heads/main). If provided, verified. | No |
+| `ref_name` | Reference name override | No |
 
 ## Outputs
 
@@ -35,11 +35,57 @@ Smart resolution of git details. Validates inputs, resolves SHA from branch/ref,
 
 ## Usage
 
+### Default (Auto-detect Default Branch)
+Resolves the repository's default branch (e.g., `main` or `master`).
+
+```yaml
+- uses: Appegy/git-context-action@v1
+  id: git-context
+  with:
+    repository: ${{ github.repository }}
+    token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+### Specific Branch
+Resolves a specific branch. Fails if the branch does not exist.
+
+```yaml
+- uses: Appegy/git-context-action@v1
+  with:
+    repository: ${{ github.repository }}
+    token: ${{ secrets.GITHUB_TOKEN }}
+    branch: 'feature/my-branch'
+```
+
+### Specific SHA
+Resolves details for a specific commit SHA.
+
+```yaml
+- uses: Appegy/git-context-action@v1
+  with:
+    repository: ${{ github.repository }}
+    token: ${{ secrets.GITHUB_TOKEN }}
+    sha: 'a1b2c3d4e5f6...'
+```
+
+### Specific Tag (Ref)
+Resolves a specific git reference (tag or branch).
+
+```yaml
+- uses: Appegy/git-context-action@v1
+  with:
+    repository: ${{ github.repository }}
+    token: ${{ secrets.GITHUB_TOKEN }}
+    ref: 'refs/tags/v1.0.0'
+```
+
+### Override Reference Name
+Manually override the `ref_name` output, useful for custom workflows.
+
 ```yaml
-steps:
-  - uses: actions/checkout@v4
-  - uses: ./
-    with:
-      repository: ${{ github.repository }}
-      token: ${{ secrets.GITHUB_TOKEN }}
+- uses: Appegy/git-context-action@v1
+  with:
+    repository: ${{ github.repository }}
+    token: ${{ secrets.GITHUB_TOKEN }}
+    ref_name: 'custom-release-name'
 ```