Skip to content

Latest commit

 

History

History
76 lines (59 loc) · 3.03 KB

README.md

File metadata and controls

76 lines (59 loc) · 3.03 KB
Raw



GitHub Readme LinkedIn

A serverless application to get dynamically generated images from your LinkedIn profile on your GitHub READMEs!



Usage

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 own URLs.


Example

<img src="[YOUR_VERCEL_PROJECT_DOMAIN]/[METHOD]?username=[YOUR_LINKEDIN_USERNAME]" />

Methods

URL Example Description
/experience [YOUR_DOMAIN]/experience?username=[YOUR_LINKEDIN_USERNAME] Your LinkedIn experience section.
/education [YOUR_DOMAIN]/education?username=[YOUR_LINKEDIN_USERNAME] Your LinkedIn education section.
/skills [YOUR_DOMAIN]/skills?username=[YOUR_LINKEDIN_USERNAME] Your LinkedIn skills section.
/languages [YOUR_DOMAIN]/languages?username=[YOUR_LINKEDIN_USERNAME] Your LinkedIn languages section.
/user [YOUR_DOMAIN]/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 your own

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

Guide on setting up Vercel 🔨
  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