Categories We Write About

Create a self-updating README

Hereโ€™s a template for a self-updating README.md file, designed to fetch dynamic content such as GitHub statistics, latest blog posts, or contribution graphs using GitHub Actions.


๐Ÿง  Self-Updating README.md Template (using GitHub Actions)

This version auto-updates daily (or as configured) using GitHub Actions.

md
# Hi there, I'm [Your Name] ๐Ÿ‘‹ ![GitHub followers](https://img.shields.io/github/followers/YOUR_GITHUB_USERNAME?label=Followers&style=social) ![GitHub User's stars](https://img.shields.io/github/stars/YOUR_GITHUB_USERNAME?affiliations=OWNER%2CCOLLABORATOR&style=social) ## ๐Ÿš€ Latest Blog Posts <!-- BLOG-POST-LIST:START --> <!-- BLOG-POST-LIST:END --> ## ๐Ÿ“Š GitHub Stats ![YOUR_GITHUB_USERNAME's GitHub stats](https://github-readme-stats.vercel.app/api?username=YOUR_GITHUB_USERNAME&show_icons=true&theme=radical) ## ๐Ÿ“ˆ GitHub Contributions ![GitHub Activity Graph](https://activity-graph.herokuapp.com/graph?username=YOUR_GITHUB_USERNAME&theme=react-dark) ## ๐Ÿ› ๏ธ Technologies & Tools - Programming: JavaScript, Python, Go - Frameworks: React, Next.js, Node.js - Tools: Git, Docker, VS Code ## ๐Ÿ“ซ Let's Connect - [Twitter](https://twitter.com/YOUR_HANDLE) - [LinkedIn](https://linkedin.com/in/YOUR_USERNAME) - [Blog](https://yourblog.com)

๐Ÿ”„ Set Up GitHub Action to Auto-Update

Create .github/workflows/update-readme.yml:

yaml
name: Update README on: schedule: - cron: '0 * * * *' # Every hour (adjust as needed) workflow_dispatch: jobs: update-readme: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v3 - name: Update Blog Posts uses: gautamkrishnar/blog-post-workflow@master with: feed_list: "https://yourblog.com/rss" - name: Commit changes run: | git config --global user.name 'github-actions[bot]' git config --global user.email '41898282+github-actions[bot]@users.noreply.github.com' git add README.md git commit -m "Updated README with latest data" || echo "No changes to commit" git push

โœ… Tips

  • Replace YOUR_GITHUB_USERNAME, blog RSS, and social links with your actual data.

  • You can add more integrations (e.g., StackOverflow, YouTube, Twitter) with additional GitHub Actions.

Let me know if youโ€™d like a version tailored for your blog, GitHub username, or specific integrations.

Share This Page:

Enter your email below to join The Palos Publishing Company Email List

We respect your email privacy

Comments

Leave a Reply

Your email address will not be published. Required fields are marked *

Categories We Write About