diff --git a/README.md b/README.md index 62066c0..cdc5ca8 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,9 @@ # apply-git-user (for GitHub Actions) Apply a well-known git user to `git config user.*`. -User | Sample image ---- | :---: -actions-user | ![actions-user](./docs/actions-user.png) -github-actions | ![github-actions](./docs/github-actions.png) -(Latest git commit user) | ![Latest git commit user](./docs/latest-commit.png) +* actions-user +* github-actions +* (Latest git commit user) @@ -14,14 +12,16 @@ github-actions | ![github-actions](./docs/github-actions.png) ``` yaml - uses: tshion/apply-git-user@(version) with: - user: (placeholder) + user: (git user) ``` -Replace `(placeholder)` with one of the following values. +Replace `(git user)` with one of the following values. -* `actions-user` -* `github-actions` -* `latest-commit` +`(git user)` | User | Description +--- | --- | --- +`actions-user` | ![actions-user](./docs/actions-user.png) | | +`github-actions` | ![github-actions](./docs/github-actions.png) | | +`latest-commit` | ![Latest git commit user](./docs/latest-commit.png) | Latest git commit user ### Use `working directory` ``` yaml @@ -32,7 +32,7 @@ Replace `(placeholder)` with one of the following values. - uses: tshion/apply-git-user@(version) with: path: from - user: (placeholder) + user: (git user) ``` ### Use `git config --global user.*` @@ -40,7 +40,7 @@ Replace `(placeholder)` with one of the following values. - uses: tshion/apply-git-user@(version) with: global: true - user: (placeholder) + user: (git user) ``` diff --git a/action.yml b/action.yml index 66149f8..b456ebb 100644 --- a/action.yml +++ b/action.yml @@ -1,8 +1,8 @@ name: "Apply git user" description: "Apply a well-known git user to 'git config user.*'." branding: - icon: "user-plus" - color: "blue" + icon: user-plus + color: orange inputs: global: diff --git a/docs/actions-user.png b/docs/actions-user.png index 6e496ea..8083917 100644 Binary files a/docs/actions-user.png and b/docs/actions-user.png differ diff --git a/docs/github-actions.png b/docs/github-actions.png index 4c0e60f..bd9313b 100644 Binary files a/docs/github-actions.png and b/docs/github-actions.png differ diff --git a/docs/latest-commit.png b/docs/latest-commit.png index 877ac25..1482318 100644 Binary files a/docs/latest-commit.png and b/docs/latest-commit.png differ