Skip to content

Commit 9a13056

Browse files
committed
docs(README): update
1 parent fcc1888 commit 9a13056

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
# Deploy to Gist
22

3-
[![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/exuanbo/actions-deploy-gist/test/main?event=push&label=test&logo=github&style=flat-square)](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)](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)
5+
[![libera manifesto](https://img.shields.io/badge/libera-manifesto-lightgrey.svg)](https://liberamanifesto.com)
6+
7+
This is a Github Action to deploy your file to Github Gist.
48

59
## Quick start
610

711
```yml
812
- uses: actions/checkout@v2
913
- name: Deploy
10-
uses: exuanbo/actions-deploy-gist@v1.0.3
14+
uses: exuanbo/actions-deploy-gist@v1
1115
with:
1216
token: ${{ secrets.TOKEN }}
1317
gist_id: from_your_gist_url
@@ -20,14 +24,12 @@
2024
### Prep work
2125
2226
1. Create a public gist if you don't have one.
23-
1. Generate a new [Personal access token](https://github.com/settings/tokens/). Only the `gist` scope is needed.
24-
25-
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. Check [Scopes for OAuth Apps](https://docs.github.com/en/developers/apps/scopes-for-oauth-apps) for details.
2628

2729
### Project setup
2830

29-
1. Edit your repo `.github/workflows/foo.yml` like in the example.
30-
1. Go to your repo **Settings > Secrets**. Add the token generated above as `TOKEN`.
31+
1. Go to the repo **Settings > Secrets**. Add the generated token as `TOKEN`.
32+
1. Edit workflow file `.github/workflows/deploy.yml` as the example above.
3133

3234
### Options
3335

@@ -45,4 +47,4 @@ Relative to your repo's root directory, e.g. `./dist/foo.bar`.
4547

4648
## License
4749

48-
[MIT](https://github.com/exuanbo/actions-deploy-gist/blob/master/LICENSE)
50+
[MIT](https://github.com/exuanbo/actions-deploy-gist/blob/main/LICENSE)

0 commit comments

Comments
 (0)