7/23/25 to 7/24/25 11:59 PM EST
Submit
#REAMDE on the Hack Club Slack
REAMDE is a Hack Club You-Ship-We-Ship about making your Github profile a little more interesting.
A Github README.md is a markdown file located in a project repository that explains what your project is and how to use it.
Profile README’s are special README’s that appear on your profile.
To create a profile README, simply create a new repository with your username with a README.MD.
E.G., idksarah/idksarah ← is my special repo.
View it at github.com/idksarah/idksarah.
See it in action at github.com/idksarah.
After completion, receive an Octocat or Copilot pin.
- Your project must display data from an API
- Your project must automatically update your profile at least every 24 hours
- You must track at least 2 hours building on Hackatime
- You must open source your code on Github
- Submission must be meaningful
For your script, use any language you like—eg. Javascript or Python.
To automate your profile updates, I suggest setting up Github Actions.
You'll also have to track your time using Hackatime.
Last thing you need is a README.md. Include the name of your project, a description, a usage guide, and images.
- Art from your Github activity using Octokit JS
- A weather display using a weather API
- An ISS tracker using the ISS's official telemetry
- A movie display using a movie API
