Skip to content

Commit a9d3888

Browse files
committed
docs(README): update
1 parent 3f0ed77 commit a9d3888

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,27 @@
44
[![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/exuanbo/actions-deploy-gist/test/main.svg?event=push)](https://github.com/exuanbo/actions-deploy-gist/actions?query=workflow%3Atest)
55
[![libera manifesto](https://img.shields.io/badge/libera-manifesto-lightgrey.svg)](https://liberamanifesto.com)
66

7-
This is a Github Action to deploy your file to Github Gist.
7+
This is a Github Action to deploy file to Github Gist.
88

99
## Quick start
1010

1111
```yml
12-
- uses: actions/checkout@v2
12+
- uses: actions/checkout@v3
1313
- name: Deploy
1414
uses: exuanbo/actions-deploy-gist@v1
1515
with:
1616
token: ${{ secrets.TOKEN }}
17-
gist_id: from_your_gist_url
18-
gist_description: "foo bar"
19-
gist_file_name: foo.bar
20-
file_path: ./dist/foo.bar
17+
gist_id: from_gist_url
18+
file_path: build/book.pdf
19+
file_type: binary
2120
```
2221
2322
## Setup
2423
2524
### Prep work
2625
2726
1. Create a gist (public or secret) if you don't have one.
28-
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.
27+
1. Generate a new [Personal access token](https://github.com/settings/tokens/). Only the `gist` scope is needed.
2928

3029
### Project setup
3130

@@ -44,15 +43,19 @@ Id portion from the gist url, e.g. `https://gist.github.com/exuanbo/`**`e885afa3
4443

4544
#### `gist_description` (optional)
4645

47-
Optional description of the gist.
46+
Description of the gist.
4847

4948
#### `gist_file_name` (optional)
5049

5150
Name of the file to be added in the gist. If not provided, the original file name from `file_path` will be used.
5251

5352
#### `file_path`
5453

55-
Relative to the current repo's root directory, e.g. `./dist/foo.bar`.
54+
Relative to the current repo's root directory, e.g. `dist/foo.bar`.
55+
56+
#### `file_type` (optional)
57+
58+
Default to `text`. It should be set to `binary` if the file is image, pdf, etc.
5659

5760
## License
5861

0 commit comments

Comments
 (0)