Skip to content

Commit 73c5cf2

Browse files
authored
Update README.md
1 parent f00c653 commit 73c5cf2

1 file changed

Lines changed: 39 additions & 5 deletions

File tree

README.md

Lines changed: 39 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -101,14 +101,48 @@ Feel free to open a **PR** or **issue**, and I'll get back to you as soon as pos
101101
4. Push to the branch (`git push origin feature/amazing-program`)
102102
5. Open a Pull Request
103103

104+
---
105+
104106
## 🎂 Birthday Checker
105107

106-
Want a birthday message from PythonProgramsV3?
108+
Get a personal birthday message from PythonProgramsV3 — runs entirely
109+
in GitHub Actions, no install needed.
110+
111+
### How to use it
112+
113+
**Step 1 — Go to the Actions tab**
114+
Click [Actions](../../actions) at the top of this repo page.
115+
116+
**Step 2 — Open the Birthday Checker workflow**
117+
In the left sidebar, click **🎂 Birthday Checker**.
118+
119+
**Step 3 — Run the workflow**
120+
Click the **Run workflow** button on the right side. A small form
121+
will drop down.
122+
123+
**Step 4 — Fill in your details**
124+
- `Your GitHub username` — your real GitHub username, e.g. `mo2ney`
125+
- `Your birthday (MM-DD)` — month and day only, e.g. `03-21` for
126+
21st March
127+
- `Owner token`**leave this blank** unless you are TheM1ddleM1n
128+
129+
**Step 5 — Click Run workflow**
130+
The green button at the bottom of the form.
131+
132+
**Step 6 — View your message**
133+
Wait a few seconds, then click the run that appears in the list.
134+
Open the **Run birthday checker** step to see your personal message.
135+
136+
> 💡 Your birthday is only used for that single run and is never
137+
> stored, committed, or visible to anyone else — only you can see
138+
> the log of a run you triggered.
139+
140+
### Rules
107141

108-
1. Head to the [Actions tab](../../actions/workflows/birthday.yml)
109-
2. Click **Run workflow**
110-
3. Enter your GitHub username and birthday (`MM-DD`)
111-
4. Run it and check the logs for your message!
142+
- Your username must be a real GitHub account or the run will exit early
143+
- Birthday format is `MM-DD` — month first, then day
144+
- June 5th is reserved for the repo creator (TheM1ddleM1n) and cannot be claimed
145+
by other users
112146

113147
---
114148

0 commit comments

Comments
 (0)