gazf / github-readme-twitter

Add Twitter to your github readme

github-readme-twitter

What is this?

Display the latest tweets on your github readme.

Usage

Insert the code below into your Github readme.

Change the ?id= value to your Twitter's screen name.

[![github-readme-twitter](https://github-readme-twitter.gazf.vercel.app/api?id=gazff)](https://github.com/gazf/github-readme-twitter)

Example

@twitter

https://github-readme-twitter.gazf.vercel.app/api?id=twitter

@nodejs

Add ?layout=wide parameter

https://github-readme-twitter.gazf.vercel.app/api?id=nodejs&layout=wide

Available parameters

id

Specify the screen name of twitter.

id must always be specified.

layout (optional)

Specify the layout.

• normal: 300 x 285, three tweets (default)
• wide: 420 x 205, two tweets

show_border (optional)

Specify whether to display border.

• on: display border (default)
• off: hide border

show_retweet (optional)

Specify whether to display retweet.

• on: display retweet (default)
• off: hide retweet

show_reply (optional)

Specify whether to display reply.

• on: display reply (default)
• off: hide reply

Host with your Vercel account