README.md

❄️ GITHUB COOL COVERS ❄️

Get dynamically generated 🌐 GitHub covers for your readmes!

⭐ Features

• Dynamically 🤖 generated covers with cool patterns.
• Updates the recent followers ✏️ avatars (in 1 or 2 days).
• Eight unique 😊 background patterns.
• Supports all 🕸️ Web Safe Fonts + 🤩 Google Fonts.
• Highly Customizable 📝.

📌 How 2️⃣ Use?

Copy-paste this into your markdown content, and that's it. Simple!

Change the username= value to your GitHub's username.

Change the text= value to update cover's title.

[![Udit's GitHub cover](/api/get-cover?username=uditkumar01&text=Hola,+I'm+Udit)](https://github.com/uditkumar01/cool-covers)

🔤 Change Font

To change the font, you can pass a query parameter ?fontFamily= with the font name.

Example: &fontFamily=Roboto

![Udit's GitHub cover](/api/get-cover?username=uditkumar01&text=Hola,+I'm+Udit&fontFamily=Roboto)

Note: The font name must be a valid font name (case sensitive). For Google fonts u can directly copy the name of the font from here: Google Fonts

🐤 Change Font Size

You can change the font size by passing a query parameter ?textFontSize= with the font size.

Example: &textFontSize=4rem

![Udit's GitHub cover](/api/get-cover?username=uditkumar01&text=Hola,+I'm+Udit&textFontSize=4rem)

Note: The font size can be any number or string.

⚒️ Change Font Weight

To change the font weight, you can pass a query parameter ?textFontWeight= with the font weight.

Example: &textFontWeight=400

![Udit's GitHub cover](/api/get-cover?username=uditkumar01&text=Hola,+I'm+Udit&textFontWeight=400)

Note: The font weight can be light/regular/bold/bolder/lighter or any number.

🎨 Change Background Color

With the help of the ?bgColor= query parameter, you can change the background color of the cover.

Use ?bgColor= with the hex code without # of the color you want to use.

Example: &bgColor=000000

![Udit's GitHub cover](/api/get-cover?username=uditkumar01&text=Hola,+I'm+Udit&bgColor=000000)

🍀 Change Text Color

Using ?textColor= query parameter, you can change the text color of the cover.

Use ?textColor= with the hex code without # of the color you want to use.

Example: &textColor=ffffff

![Udit's GitHub cover](/api/get-cover?username=uditkumar01&text=Hola,+I'm+Udit&textColor=ffffff)

💎 Add Background Pattern

To add a background pattern, you can pass a query parameter ?pattern= with the pattern name.

Example: &pattern=p2

![Udit's GitHub cover](/api/get-cover?username=uditkumar01&text=Hola,+I'm+Udit&pattern=p2)

If you wish you can 💻 contribute by creating a new pattern and designs.

Note: Currently, eight patterns are available. p1 to p8.

🔥 Add Grayscale Effect

Using ?grayscale= query parameter, you can add a grayscale effect to the cover's background pattern.

✅ Empty query parameter will remove the grayscale effect.

✅ Non-empty the query parameter to add the grayscale effect.

Example: &grayscale=true // Adds the grayscale effect.

Example: &grayscale='' // Removes the grayscale effect.

![Udit's GitHub cover](/api/get-cover?username=uditkumar01&text=Hola,+I'm+Udit&pattern=p2&grayscale=true)

🔵 Change Avatar Radius

You can easily change the avatar radius of recent followers by passing a query parameter ?avatarRadius= with the radius value.

Its value should be a number (can have any unit like px, rem, em, etc).

Example: &avatarRadius=50

![Udit's GitHub cover](/api/get-cover?username=uditkumar01&text=Hola,+I'm+Udit&pattern=p2&grayscale=true&avatarRadius=50)

📌 Change Cover's Title Word Spacing

You can customize the word spacing of the cover's title by passing a query parameter ?textWordSpacing= with the spacing value.

Its value should be a number (can have any unit like px, rem, em, etc).

Example: &textWordSpacing=25px

![Udit's GitHub cover](/api/get-cover?username=uditkumar01&text=Hola,+I'm+Udit&pattern=p2&textFontSize=6rem&textWordSpacing=25px)

📌 Change Cover's Title Letter Spacing

You can customize the letter spacing of the cover's title by passing a query parameter ?textLetterSpacing= with the spacing value.

Its value should be a number (can have any unit like px, rem, em, etc).

Example: &textLetterSpacing=25px

![Udit's GitHub cover](/api/get-cover?username=uditkumar01&text=Hola,+I'm+Udit&pattern=p2&textFontSize=6rem&textLetterSpacing=8px)

🖼️ All Different Patterns

⭐ Star this project on GitHub

Made with ❣️ and JavaScript.