Update README.md to reflect new project title and description

This commit is contained in:
Luke Hagar
2025-11-17 16:18:57 +00:00
parent 2632d92463
commit 4a7678bf1a
3 changed files with 102 additions and 2 deletions

30
.github/workflows/readme-scribe.yml vendored Normal file
View File

@@ -0,0 +1,30 @@
name: Update README
on:
push:
schedule:
- cron: "0 */1 * * *"
jobs:
markscribe:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: muesli/readme-scribe@master
env:
GITHUB_TOKEN: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
with:
template: "templates/README.md.tpl"
writeTo: "README.md"
- uses: stefanzweifel/git-auto-commit-action@v7
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
commit_message: Update generated README
branch: main
commit_user_name: readme-scribe 🤖
commit_user_email: actions@github.com
commit_author: readme-scribe 🤖 <actions@github.com>

View File

@@ -1,2 +1,3 @@
# profile-stats
An example repository for some of the great things you can do with GitHub profile stats automation
# Awesome GitHub Profile
A collection of all of my favorite GitHub automation tools.

69
templates/README.md.tpl Normal file
View File

@@ -0,0 +1,69 @@
# Awesome GitHub Profile
A collection of all of my favorite GitHub automation tools.
### Hi there 👋
#### 👷 Check out what I'm currently working on
{{range recentContributions 10}}
- [{{.Repo.Name}}]({{.Repo.URL}}) - {{.Repo.Description}} ({{humanize .OccurredAt}})
{{- end}}
#### 🌱 My latest projects
{{range recentRepos 10}}
- [{{.Name}}]({{.URL}}) - {{.Description}}
{{- end}}
#### 🍴 My recent forks
{{range recentForks 10}}
- [{{.Name}}]({{.URL}}) - {{.Description}}
{{- end}}
#### 🔭 Latest releases I've contributed to
{{range recentReleases 10}}
[![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username={{.Owner.Login}}&repo={{.Name}})]({{.URL}})
{{- end}}
#### 🔨 My recent Pull Requests
{{range recentPullRequests 10}}
- [{{.Title}}]({{.URL}}) on [{{.Repo.Name}}]({{.Repo.URL}}) ({{humanize .CreatedAt}})
{{- end}}
#### 📜 My recent blog posts
{{range rss "https://.../posts/index.xml" 5}}
- [{{.Title}}]({{.URL}}) ({{humanize .PublishedAt}})
{{- end}}
#### 📓 Gists I wrote
{{range gists 5}}
- [{{.Description}}]({{.URL}}) ({{humanize .CreatedAt}})
{{- end}}
#### ⭐ Recent Stars
{{range recentStars 10}}
- [{{.Repo.Name}}]({{.Repo.URL}}) - {{.Repo.Description}} ({{humanize .StarredAt}})
{{- end}}
#### ❤️ These awesome people sponsor me (thank you!)
{{range sponsors 5}}
- [{{.User.Login}}]({{.User.URL}}) ({{humanize .CreatedAt}})
{{- end}}
#### 👯 Check out some of my recent followers
{{range followers 5}}
- [{{.Login}}]({{.URL}})
{{- end}}
#### 💬 Feedback
Say Hello, I don't bite!
#### 📫 How to reach me
- Twitter: https://twitter.com/...
- Fediverse: https://mastodon.social/@...
- Blog: https://...
Want your own self-generating profile page? Check out [readme-scribe](https://github.com/muesli/readme-scribe)!
<!-- comments will be preserved -->