Skip to content

Commit e3c6e85

Browse files
committed
Update README.md
1 parent a08d38b commit e3c6e85

File tree

2 files changed

+41
-2
lines changed

2 files changed

+41
-2
lines changed

.github/workflows/gadpp.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ on: [push]
33
jobs:
44
hello_world_job:
55
runs-on: ubuntu-latest
6-
name: Update Home Page
6+
name: Update GitHub Profile Page
77
steps:
88
- name: Checkout
99
uses: actions/checkout@v2

README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,40 @@
1-
# github-action-dynamic-profile-page
1+
# Dynamic Profile Page On Github
2+
3+
GitHub Action to push subdirectories to separate repositories.
4+
5+
### Why?
6+
7+
GitHub announced a special repo (github_username/github_username) its README.md file will appear on your profile. People liked it a lot and started using some static pages with fancy texts and images. This GitHub action helps you to add a section that is updated dynamically when you commit a repository that uses this action.
8+
9+
## Usage
10+
11+
Follow the steps;
12+
- Create your special repository if not exists.
13+
- Add `<!-- START gadpp -->` add the end of the README.md file of the special repo.
14+
- Create a personal access token [here](https://github.com/settings/tokens) and set the `repo` permission.
15+
- Add the access token created in previous step to the repository (that uses this action) as a secret with name `API_TOKEN_GITHUB`.
16+
- Create the YML file for the action under `.github/workflows`. You can use the sample given below.
17+
18+
## Example YML File To Create A Workflow With This Action
19+
20+
```yml
21+
on: [push]
22+
23+
jobs:
24+
hello_world_job:
25+
runs-on: ubuntu-latest
26+
name: Update GitHub Profile Page
27+
steps:
28+
- name: Checkout
29+
uses: actions/checkout@v2
30+
- name: GADPP
31+
uses: umutphp/github-action-dynamic-profile-page@v1
32+
id: gadpp
33+
env:
34+
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
35+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
36+
with:
37+
github-username: 'YOUR_GITHUB_USERNAME'
38+
user-email: 'EMAIL_USED_ON_GITHUB'
39+
40+
```

0 commit comments

Comments
 (0)