Skip to content

Commit 69c4ef8

Browse files
committed
docs(README): update
1 parent b999c61 commit 69c4ef8

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,28 +23,32 @@ This is a Github Action to deploy your file to Github Gist.
2323
2424
### Prep work
2525
26-
1. Create a public gist if you don't have one.
26+
1. Create a gist (public or secret) if you don't have one.
2727
1. Generate a new [Personal access token](https://github.com/settings/tokens/). Only the `gist` scope is needed. Check [Scopes for OAuth Apps](https://docs.github.com/en/developers/apps/scopes-for-oauth-apps) for details.
2828

2929
### Project setup
3030

31-
1. Go to the repo **Settings > Secrets**. Add the generated token as `TOKEN`.
31+
1. Go to the repo **Settings > Secrets**. Add the generated token with name `TOKEN`.
3232
1. Edit workflow file `.github/workflows/deploy.yml` as the example above.
3333

3434
### Options
3535

36+
#### `token`
37+
38+
The personal access token for updating gist.
39+
3640
#### `gist_id`
3741

3842
The id portion from your gist url, e.g. `https://gist.github.com/exuanbo/`**`e885afa349a0e5d1cfb408e46d6a37bc`**.
3943

40-
#### `gist_file_name`
44+
#### `gist_file_name` (optional)
4145

42-
Name of the file to be added in your gist. If not provided, the original file name from `file_path` will be used.
46+
The name of the file to be added in your gist. If not provided, the original file name from `file_path` will be used.
4347

4448
#### `file_path`
4549

4650
Relative to your repo's root directory, e.g. `./dist/foo.bar`.
4751

4852
## License
4953

50-
[MIT](https://github.com/exuanbo/actions-deploy-gist/blob/main/LICENSE)
54+
[MIT License](https://github.com/exuanbo/actions-deploy-gist/blob/main/LICENSE) © 2021 [Exuanbo](https://github.com/exuanbo)

0 commit comments

Comments
 (0)