GitHub Readme LinkedIn

Get dynamically generated images from your LinkedIn profile on your GitHub READMEs!

Demo

Example profile README

Recommendation

If you want to use this project on your GitHub profile, I recommend you fork and deploy it to your own Vercel instance and use this project from your personal URLs because github-readme-linkedin.vercel.app hosted on Vercel free plan and used by many people, therefore it could be break at any time!

Check out this issue for more information...

Usage

<img src="https://github-readme-linkedin.vercel.app/[METHOD]?username=[YOUR_LINKEDIN_USERNAME]" />

Methods

APP_URL = https://github-readme-linkedin.vercel.app

URL	Example	Description
/experience	[APP_URL]/experience?username=[YOUR_LINKEDIN_USERNAME]	Your LinkedIn experience section.
/education	[APP_URL]/education?username=[YOUR_LINKEDIN_USERNAME]	Your LinkedIn education section.
/skills	[APP_URL]/skills?username=[YOUR_LINKEDIN_USERNAME]	Your LinkedIn skills section.
/languages	[APP_URL]/languages?username=[YOUR_LINKEDIN_USERNAME]	Your LinkedIn languages section.
/user	[APP_URL]/user?username=[YOUR_LINKEDIN_USERNAME]	Your Fullname, Headline and Location.

Parameters

Name	Example	Description	Required
username	?username=[YOUR_LINKEDIN_USERNAME]	Your LinkedIn username.	YES
limit	?username=[YOUR_LINKEDIN_USERNAME]&limit=10	Count of the lists items.	NO

Deploy

You can deploy and use this project without any errors on your own Vercel instance by the following steps:

Steps 🔨

1. Go to vercel.com
2. Click on Login
   
3. Sign in with GitHub by pressing Continue with GitHub
   
4. Sign into GitHub and allow access to all repositories, if prompted
5. Fork this repo
6. Go back to your Vercel dashboard
7. Select Import Project
   
8. Select Import a Git Repository
   
9. Select root and keep everything as is, just place your LinkedIn cookie called li_at as your environment variable named LINKEDIN_TOKEN and click Deploy
10. You're good to go. See your domains to use the API!

Technologies

• TypeScript
• Node.js
• Express.js
• Serverless

Contributions are welcomed!

Made with ❤️ and TypeScript.