Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gazf/github-readme-twitter
Add Twitter to your github readme
https://github.com/gazf/github-readme-twitter
d3js github readme twitter twitter-api vercel
Last synced: about 2 months ago
JSON representation
Add Twitter to your github readme
- Host: GitHub
- URL: https://github.com/gazf/github-readme-twitter
- Owner: gazf
- License: mit
- Archived: true
- Created: 2020-08-11T02:52:05.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-13T21:02:29.000Z (over 1 year ago)
- Last Synced: 2024-07-31T23:46:44.377Z (4 months ago)
- Topics: d3js, github, readme, twitter, twitter-api, vercel
- Language: JavaScript
- Homepage: https://github-readme-twitter.vercel.app
- Size: 42 KB
- Stars: 106
- Watchers: 3
- Forks: 14
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-profile - Github Readme Twitter - Show your latest tweet on your readmes. (Tools)
- fucking-awesome-github-profile-readme - Github Readme Twitter - Show your latest tweet on your readmes. (Tools)
- awesome-readme-tools - GitHub Readme Twitter - Add Twitter to your github readmes. (Statistical Tools (Widgets))
- awesome-github-profile-readme - Github Readme Twitter - Show your latest tweet on your readmes. (Tools)
- awesome-ubc-profile-readme - Github Readme Twitter - Show your latest tweet on your readmes. (Tools)
- awesome-github-profile - Github Readme Twitter
README
# github-readme-twitter
[](https://dependabot.com/)
## 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.
```
[](https://github.com/gazf/github-readme-twitter)
```
## Example
### @twitter
`https://github-readme-twitter.gazf.vercel.app/api?id=twitter`
[](https://github.com/gazf/github-readme-twitter)
### @nodejs
Add `?layout=wide` parameter
`https://github-readme-twitter.gazf.vercel.app/api?id=nodejs&layout=wide`
[](https://github.com/gazf/github-readme-twitter)
## 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
[](https://vercel.com/import/git?s=https%3A%2F%2Fgithub.com%2Fgazf%2Fgithub-readme-twitter)