Creating a self-updating GitHub README using rtweet and GitHub Actions

Tags: #<Tag:0x00007f0e9fefa830> #<Tag:0x00007f0e9fefa628>

rOpenSci package or resource used*

rtweet

What did you do?

After GitHub allows users to host their own README file on the profile page, people started to share many awesome README examples. Inspired by this tweet where Simon William used it to share his updates from blogs and commits, I created a README updating my latest tweet instead of having a static one by doing the following actions:

  1. Use rtweet to get my latest tweet.
  2. Use tweetrmd and webshot2 to turn the tweet into a screenshot.
    The entire process is deployed on GitHub using GitHub Actions templates from my friend Malcolm Barrett.

URL or code snippet for your use case*

Image

Sector

academic

Field(s) of application

Doesn’t really fall into the typical fields. How about professional development?

Twitter handle

@zhiiiyang

4 Likes