easy-github-profile

A zero-effort GitHub profile README setup. Fork it and your profile is live instantly — fully customizable, no coding required.

👇 See setup instructions below.

---

👤 Example profile.,

---

✨ Features

• Up in minutes — just follow the Quick Start steps below, no configuration required

• One file to configure — everything lives in config.json, no code to touch

• Animations — animated wave header, typewriter effect, and more

• Dark/light mode support — labels automatically adapt to the viewer's theme

• Fully automatic — GitHub Actions generates all SVGs on every push and on a daily schedule

• Daily auto-update — profile stays in sync with your GitHub data every day at midnight UTC

• No dependencies — nothing to install

• GitHub API integration — name and bio are pulled directly from your GitHub profile, no manual input needed

• Fork-friendly — works for any GitHub username automatically, no hardcoded values

---

🚀 Quick Start

1. Fork this repository

Click the Fork button at the top right of this page.

2. Name the repository {your-username}

When forking, you can set the name directly. If you missed it, go to Settings and rename it there. The name must match your GitHub username exactly for the profile README to work.

⚠️ If you already have a {your-username} repository, you'll need to delete it first.

3. Clean up README.md

Remove any content that doesn't belong on your profile page — the project title, description, example note, and setup instructions.

4. Trigger the Action

Go to Actions → Generate Assets → Run workflow. Your profile is live. 🎉

5. Customize (optional)

Edit config.json to personalize your typing lines, badge sections, colors, and more. See the Customize section below for details.

---

⚙️ Customize

All customization happens in config.json.

🖼️ Header

"header": {
  "name": null,
  "bio": null
}

Field	Description
name	Your display name. null = fetched from your GitHub profile
bio	Your subtitle text. null = fetched from your GitHub profile bio

---

⌨️ Typing

"typing": {
  "lines": [
    ".NET & C# Developer",
    "ASP.NET Core · Node.js"
  ]
}

Field	Description
lines	Lines shown in the typewriter animation, one by one. null or [] = fetched from your GitHub profile (bio, company, location, blog)

---

🏷️ Sections

"sections": [
  {
    "id": "lang",
    "label": "Languages",
    "badges": [
      { "text": "C#",         "color": "#1d7a1a" },
      { "text": "JAVASCRIPT", "color": "#e0c910" }
    ]
  }
]

Field	Description
id	Used as the output filename: assets/sections/{id}.svg
label	Section heading shown above the badges
badges	List of badge objects
badges[].text	Badge label (displayed in uppercase)
badges[].color	Badge background color (hex)

To add a new section, add a new object to the array and add <img src="assets/sections/{id}.svg"/> to README.md.

---

📝 Editing README.md

All generated assets are just image files — place them anywhere in README.md however you like. Here's the full example used in this repo:

<img src="assets/header.svg" width="100%"/>
<br>
<img src="assets/typing.svg" width="100%"/>
<br>
<div align="center">

  <img src="assets/sections/lang.svg"/>
  <br>
  <br>
  <img src="assets/sections/fw.svg"/>
  <br>
  <br>
  <img src="assets/sections/tools.svg"/>

</div>
<br>
<img src="assets/footer.svg" width="100%"/>

Asset	Path
Header	assets/header.svg
Typing animation	assets/typing.svg
Section (label + badges)	assets/sections/{id}.svg
Footer	assets/footer.svg

---

📄 License

MIT © BerkaySevinc