Skip to content

Commit 398698f

Browse files
committed
Fix README
1 parent 7423874 commit 398698f

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,15 @@
1111
1212
<!-- markdownlint-disable -->
1313
14-
> Create an installation access token for a GitHub app from your terminal
14+
> Manage installation access tokens for GitHub apps from your terminal
15+
16+
[![License](https://img.shields.io/github/license/link-/gh-token?style=flat-square)](LICENSE)
1517
16-
[![gh-token size](https://img.shields.io/github/size/link-/gh-token/gh-token?style=flat-square)](gh-token) [![License](https://img.shields.io/github/license/link-/gh-token?style=flat-square)](LICENSE) ![platforms supported](https://img.shields.io/static/v1?style=flat-square&label=platform&message=macos%20%7C%20linux)
1718
<!-- markdownlint-restore -->
1819
19-
[Creates an installation access token](https://docs.github.com/en/rest/reference/apps#create-an-installation-access-token-for-an-app) that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account.
20-
Installation tokens expire 1 hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token.
20+
[Creates an installation access token](https://docs.github.com/en/rest/reference/apps#create-an-installation-access-token-for-an-app) to make authenticated API requests.
21+
22+
Installation tokens expire **1 hour** from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token.
2123
2224
You can use this access token to make pretty much any REST or GraphQL API call the app is authorized to make!
2325
@@ -33,7 +35,7 @@ In order to use GitHub's [REST](https://docs.github.com/en/rest) or [GraphQL](ht
3335
1. never (automatically) expire. They have an indefinite lifetime (or at least until you regenerate them)
3436
1. cannot be revoked (they're only revoked when a new one is generated)
3537
36-
With an access token generated with a GitHub App you don't have to worry about the concerns above. These tokens have a limited scope and lifetime. Just make sure you handle the token safely (avoid leaking). In the worst case scenario, the token will expire in 1 hour from creation time.
38+
With an access token generated with a GitHub App you don't have to worry about the concerns above. These tokens have a limited scope and lifetime. Just make sure you handle the token safely (avoid leaking). In the worst case scenario, the token will expire in **1 hour from creation time.**
3739

3840
## Installation
3941

@@ -64,7 +66,7 @@ Compatible with [GitHub Enterprise Server](https://github.com/enterprise).
6466

6567
```text
6668
NAME:
67-
gh-token - Generate a GitHub App installation token
69+
gh-token - Manage GitHub App installation tokens
6870
6971
USAGE:
7072
gh-token [global options] command [command options] [arguments...]
@@ -262,7 +264,7 @@ jobs:
262264
# before passing it to gh-token
263265
- name: "Create access token"
264266
run: |
265-
token=$(./gh token generate \
267+
token=$(gh token generate \
266268
--key-base64 $(printf "%s" "$APP_PRIVATE_KEY" | base64 -w 0) \
267269
--app-id $APP_ID \
268270
--hostname "github.example.com" \

0 commit comments

Comments
 (0)