GitHub Activity in Readme

Updates README.md with the recent GitHub activity of a user.

Instructions

Add the comment  (entry point) within README.md. You can find an example here.
It's the time to create a workflow file.

.github/workflows/update-readme.yml

name: Update README

on:
  schedule:
    - cron: '*/30 * * * *'
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    name: Update this repo's README with recent activity

    steps:
      - uses: actions/checkout@v2
      - uses: jamesgeorge007/github-activity-readme@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

The above job runs every half an hour, you can change it as you wish based on the cron syntax.

Please note that only those public events that belong to the following list show up:-

IssueEvent
IssueCommentEvent
PullRequestEvent

You can find an example here.

Override defaults

Use the following input params to customize it for…

github-readme-quotes

Dynamic quote generator for your GitHub readmes

Github Readme Quotes

Copy and paste the following markdown content to display the quote.

![Quote](https://github-readme-quotes.herokuapp.com/quote)

Themes

You can display your quote in different themes without any manual customization.

Use ?theme=THEME_NAME parameter as shown below.

![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark)

Available Themes

dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula

Gotham

Dark

Light Theme

You can explore different themes here.

Feel free to contribute different themes.

Layouts

You can also change the layout of your templates.

Use ?layout=LAYOUT parameter as shown below

![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark&layout=socrates)

Layout 1 (Default)

Layout 2 (Socrates)

You can explore different layouts here.

Feel free to contribute different layouts.

Animations

You can also add animations to your templates.

Use ?animation=ANIMATION paramater as shown below

![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark&animation=grow_out_in)

Animation 1

You can explore different animations…

10 Standout GitHub Profile READMEs

Lee Reilly on July 23, 2020

My good friend and colleague @bdougieyo is at Codeland today and is giving away early access to Codespaces to three lucky people who create a profi...

Read full post

David Dal Busco • Jul 23 '20 • Edited

The chess README is pretty slick!

I really enjoy the one of @brunnerlivio too, there's something "old'school cool" there.

👉 GitHub

Brian Douglas • Jul 23 '20 • Edited

I am a fan of the old school and always a fan of the underrated marquee

Lee Reilly • Jul 26 '20

No kidding! The ~~80s~~ 90s called...

^{Source: github.com/bdougie}

Mikiko Bazeley • Dec 17 '20

Omg I love it!

Livio Brunner • Jul 24 '20

Aww thank you!
At this point I want to mention, its inspired by fnkys awesome README. As well as sindresorhus tweet which helped me to build the marquee :-)

Jimmy Cook • Jul 26 '20 • Edited

Here is my new github profile README

💚💚💚💚💚

Jimmy Cook • Jul 26 '20

Lol amazing!

Lee Reilly • Jul 27 '20

The folks contributing to this Tweet show real... commitment...

Lee Reilly

@leereilly

This post (especially in the comments) highlights some incredibly imaginative and creative @github profile READMEs 💚 dev.to/github/10-stan…

15:16 PM - 27 Jul 2020

0 2

Jimmy Cook • Jul 27 '20

Just happy to push my changes

Gonna stash these jokes for later. Might be able to cherry-pick a few for an upcoming Dev post...

David Obodo • Nov 8 '22

super nice

Avinal Kumar • Jul 26 '20 • Edited

Check this out. Coding Activity Graph on your Profile README. Uses WakaTime API to automatically update your stats every night.
github.com/avinal/Profile-Readme-W...

Ryan Lanciaux • Jul 23 '20 • Edited

Thank you for this excellent article - love this feature of GitHub, and seeing all the creative things people are doing. Especially pumped to see the visitor counter making a come back :D

If anyone wants to add the retro counter to their profile (like @sagar-viradiya's profile) you can add it like this.
![Visitor Count](https://profile-counter.glitch.me/{YOUR USER}/count.svg)

Slightly more expanded version of these instructions are available here :D

For anyone that's interested in making their own visitor counter, check out this guide I wrote on creating (or forking the GlitchApp) to make your own visitor counter. 🚀 The main gist of this one is you run a node+Express app (although it could be a serverless function, other language/framework, etc) that responds to an svg request with the next count. The headers should alert GitHub's caching layer to re-request the image every time.

Sagar Viradiya • Jul 26 '20

Thanks for creating this!

Kushagra Bansal • Aug 8 '20

Thanks for the information! Was looking for this. 😊

James George • Jul 24 '20

Here's a GitHub Action that updates README with the recent activity of a user:-

jamesgeorge007 / github-activity-readme

Updates README with the recent GitHub activity of a user

View on GitHub

Puneet Gopinath • May 21 '21

Hey James George, you no longer maintain it. So here is a fork of it to use instead:

Readme-Workflows / recent-activity

Add your recent activity to your profile readme!

Recent Activity

This GitHub Action is a Fork of the original GitHub Activity Readme Action by jamesgeorge007.
Its our goal is to improve the original GitHub Action while also providing new features for the users.

Live Preview

This is an example live preview that is updated every time a commit is pushed using github actions.

Last Updated: Thursday, May 20th, 2021, 3:17:39 PM (GMT)

❗️ Closed issue #5 in Readme-Workflows/recent-activity
🎉 Merged PR #6 in Readme-Workflows/recent-activity
🗣 Commented on #3 in Readme-Workflows/recent-activity
❗️ Closed issue #4 in Readme-Workflows/recent-activity
💪 Opened PR #6 in Readme-Workflows/recent-activity

Settings

The Action currently has the following Settings that you can set through the with option.

Option	Description	Default
`GH_USERNAME`	The User to get latest activity from	Repository Owner
`COMMIT_MSG`	The Commit Message to use when updating the README	`⚡ Update README with the recent activity`
`MAX_LINES`	How many activities to display	`5`

…

Arturs Smirnovs • Jul 28 '20

Here is a tool that could help you to get started with github readme :)
Add description / social media / badges and other stuff with just few clicks..

arturssmirnovs / github-profile-readme-generator

GitHub profile readme generator allows you to create nice and simple GitHub profile readme files that will be included in your profile previews.

Github Readme Generator

Hi there 👋.

⭐⭐⭐ Check out this tool here.

This project allows you to easily create attractive and simple GitHub Readme files that you can copy/paste in your profile. It's currently available in English and Spanish.

You can include things like headers, subtitles, skills, a banner image, additional information, social media links, badges and GitHub statistics.

Go to: arturssmirnovs.github.io/github-pr...
Fill any inputs you like
Copy the code generated in the Code section
Create a new repository in your GitHub account with the same name as your GitHub username
Add a readme.md file to your new repository
Paste the copied code into the readme file and save
Enjoy!

Preview

Top Contributors

@arturssmirnovs @max-programming @fx2000 @DenverCoder1

Resources Used

Name	Repository Link
Github Readme Stats	github.com/anuraghazra/github-read...
Github Profile Views Counter	github.com/arturssmirnovs/github-p...
Github Profile Trophy	github.com/ryo-ma/github-profile-t...
Github Readme Streak Stats	github.com/DenverCoder1/github-rea...
Simple icons	github.com/simple-icons/simple-icons
Simple Translator	github.com/andreasremdt/simple-tra...

Lee Reilly • Jul 26 '20 • Edited

Graphics are a bit blocky, but here's mine...

Ahmad Sawalqeh • Aug 25 '20

I used a combination of several tools to make this piece of art you can check it out here! GitHub Account

Ronaldo Hoch • Aug 26 '20

Nice!
How do you made this Contribution Stats?

Harshal Jadhav • Aug 6 '20

Here's mine which shows your latest medium blogs.

checkout my repo github.com/harshalrj25/mediumblog-... to add medium blogs to your profile.

Tanishq Singh • Oct 8 '22

tic tac toe in github readme??
Github

Shravan Kumar B • Nov 22 '20

Hi, do check this project, to beautify your profile readme. Star it, if you like it.

GitHub Dynamic Animated Quote Generator

shravan20 / github-readme-quotes

Elango Sundar • Jul 24 '20

Nice, we have additional github readme templates available in github.com/elangosundar/awesome-RE...

Apurv Shah • Jul 24 '20

github.com/ApurvShah007
A great combination of the many open-source templates!

Add your name with just a click??
Github

Hrittik Roy • Jul 25 '20

Yah created one your reviews will mean a lot to me ❤️
It has gif and counters
GitHub

github.com/hrittikhere - very cool! 💜

Makes me think of / want to play github.com/maxilevi/project-skylines 😄

Gautam krishna R • Jul 24 '20

Created a GitHub action too for updating the readme with your latest blog posts and StackOverflow activity automatically: github.com/gautamkrishnar/blog-pos...