everything you need to get your github profile readme up and running.
github has a special feature — a repository that matches your username becomes your public profile README. here's how to set it up.
username/username is a special repository.
its README.md will appear on your public github profile. this is where the markdown generated by readmify goes.
go to github and create a new repository. the name must exactly match your github username (case-sensitive).
github.com/newset the repository to public and check the box to initialize it with a README file.
your-usernameuse readmify to pick a template, fill in your details, and copy the generated markdown.
browse templatesopen the README.md file in your profile repo, click the edit button, paste the generated markdown, and commit the changes.
the generator fetches your repos and stats via the github api. a personal access token (PAT) unlocks higher rate limits and private repo access.
the public github api allows 60 requests/hour without authentication. with a personal access token, this increases to 5,000 requests/hour— enough to fetch repos, languages, and stats without hitting limits.
go to your github account and navigate to the token creation page.
github.com/settings/tokens/newfill in a descriptive name and select the scopes you need. for readmify, only public access is required.
readmify-access90 days (recommended)click Generate tokenat the bottom. copy the token immediately — github will only show it once.
head to the generator page and paste your token into the access token field. it will be used for that session only.
go to generator