Skip to content

Commit 1160a13

Browse files
committed
docs(README): update
1 parent 18bf3de commit 1160a13

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Deploy to Gist
22

3-
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/exuanbo/actions-deploy-gist)](https://github.com/exuanbo/actions-deploy-gist/releases)
4-
[![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/exuanbo/actions-deploy-gist/test/main?event=push)](https://github.com/exuanbo/actions-deploy-gist/actions?query=workflow%3Atest)
3+
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/exuanbo/actions-deploy-gist.svg)](https://github.com/exuanbo/actions-deploy-gist/releases)
4+
[![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

77
This is a Github Action to deploy your file to Github Gist.
@@ -15,6 +15,7 @@ This is a Github Action to deploy your file to Github Gist.
1515
with:
1616
token: ${{ secrets.TOKEN }}
1717
gist_id: from_your_gist_url
18+
gist_description: "foo bar"
1819
gist_file_name: foo.bar
1920
file_path: ./dist/foo.bar
2021
```
@@ -35,19 +36,23 @@ This is a Github Action to deploy your file to Github Gist.
3536

3637
#### `token`
3738

38-
The personal access token for updating gist.
39+
Personal access token for updating gist.
3940

4041
#### `gist_id`
4142

42-
The id portion from your gist url, e.g. `https://gist.github.com/exuanbo/`**`e885afa349a0e5d1cfb408e46d6a37bc`**.
43+
Id portion from the gist url, e.g. `https://gist.github.com/exuanbo/`**`e885afa349a0e5d1cfb408e46d6a37bc`**.
44+
45+
#### `gist_description` (optional)
46+
47+
Optional description of the gist.
4348

4449
#### `gist_file_name` (optional)
4550

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.
51+
Name of the file to be added in the gist. If not provided, the original file name from `file_path` will be used.
4752

4853
#### `file_path`
4954

50-
Relative to your repo's root directory, e.g. `./dist/foo.bar`.
55+
Relative to the current repo's root directory, e.g. `./dist/foo.bar`.
5156

5257
## License
5358

0 commit comments

Comments
 (0)