Conrad Crawford b3b683c272 Add actual readme
2021-06-19 21:30:44 -04:00
2021-06-19 19:57:44 -04:00
2021-06-19 21:10:49 -04:00
2021-06-16 22:56:42 -04:00
2021-06-16 22:56:42 -04:00
2021-06-16 22:56:42 -04:00
2021-06-19 19:57:44 -04:00
2021-06-19 21:30:44 -04:00
2021-06-16 22:56:42 -04:00
2021-06-19 19:57:44 -04:00

lanyard-profile-readme

🏷️ Utilize Lanyard in your GitHub Profile

Special thanks to @Phineas for creating Lanyard, and making this project possible

Usage

(Make sure you're in the Lanyard Discord for this to work!

In a README.md file, include the following, replacing :id with your Discord user ID.

[![Discord Presence](https://lanyard-profile-readme.vercel.app/api/:id)](https://discord.com/users/:id)

It should display something similar the following (I am using my Discord user ID as an example):

Discord Presence

Options (wip)

There are a few options to customize this display using query parameters:

Theme

Append the query param theme=:theme to the end of the URL, replacing :theme with either light or dark. This will change the background and the font colors, but the background can be overridden with the Background Color parameter.

Background Color

Append the query param bg=:color to the end of the URL, replacing :color with a hex color of your choice (omit the #)

Toggle Animated Avatar

If you have an animated avatar, append the query param animated=:bool to the end of the URL, replacing :bool with true or false. This is set to true by default.

Description
🏷️ Discord Presence in your GitHub Profile
Readme 1.9 MiB
Languages
TypeScript 98.5%
Dockerfile 0.9%
CSS 0.4%
JavaScript 0.2%