Skip to content

Commit

Permalink
Update urls in root README
Browse files Browse the repository at this point in the history
  • Loading branch information
Snailedlt committed Aug 9, 2023
1 parent 9649f53 commit 5d8956b
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
# Markdown Videos

[![wakatime](https://wakatime.com/badge/github/Snailedlt/Markdown-Videos.svg)](https://wakatime.com/badge/github/Snailedlt/Markdown-Videos)
![Vercel](https://therealsujitk-vercel-badge.vercel.app/?app=markdown-videos)
![License](https://img.shields.io/badge/license-MIT-blue)
![Maintained](https://img.shields.io/badge/Maintained%3F-yes-green.svg)

An open source API that adds a play button to a youtube video thumbnail, provided the video ID.
An open source [website](http://markdown-videos.jorgenkh.no/) and [API](http://markdown-videos-api.jorgenkh.no/) that adds a play button to a youtube video thumbnail, provided the video ID.
Markdown Videos lets you embed Youtube videos into GitHub markdown with ease!

## Showcase

||Preview|Info|
|--|--|--|
|Before|https://youtu.be/8lGpZkjnkt4|<ul><li>No Preview</li><li>Redirects to video</li></ul>|
|After|[![](https://markdown-videos.vercel.app/youtube/8lGpZkjnkt4)](https://youtu.be/8lGpZkjnkt4)|<ul><li>Clearly shows it's a youtube video</li><li>Play button and backdrop added</li><li>Black bars removed</li><li>Redirects to video</li></ul>|
|After (GIF)|[![](https://markdown-videos.vercel.app/youtube/8lGpZkjnkt4.gif)](https://youtu.be/8lGpZkjnkt4.gif)|<ul><li>Clearly shows it's a youtube video</li><li>Play button and backdrop added</li><li>:sparkles: Animated GIF :sparkles: </li><li>Redirects to video</li></ul>|
|After|[![](http://markdown-videos-api.jorgenkh.no/youtube/8lGpZkjnkt4)](https://youtu.be/8lGpZkjnkt4)|<ul><li>Clearly shows it's a youtube video</li><li>Play button and backdrop added</li><li>Black bars removed</li><li>Redirects to video</li></ul>|
|After (GIF)|[![](http://markdown-videos-api.jorgenkh.no/youtube/8lGpZkjnkt4.gif)](https://youtu.be/8lGpZkjnkt4.gif)|<ul><li>Clearly shows it's a youtube video</li><li>Play button and backdrop added</li><li>:sparkles: Animated GIF :sparkles: </li><li>Redirects to video</li></ul>|

## Supported video services

Expand All @@ -24,15 +25,13 @@ Markdown Videos lets you embed Youtube videos into GitHub markdown with ease!

## How to use?

The simplest way to use markdown-videos is to use [the website](https://markdown-videos.vercel.app/).

If you want to use the API, see the [API README](https://github.com/Snailedlt/Markdown-Videos/blob/main/apps/api/README.md)
The simplest way to use markdown-videos is to use [the website](http://markdown-videos.jorgenkh.no/). If you want to use the API, see the [API README](https://github.com/Snailedlt/Markdown-Videos/blob/main/apps/api/README.md) for more info

## Contributing

Markdown Videos is still under development, please open an [issue](https://github.com/Snailedlt/Markdown-Videos/issues) if you find any bugs, or if you want to suggest new features.

I also accept and highly appreciate Pull Requests. If you have anything to contribute, please read on.
Pull requests are also accepted and highly appreciated. If you have anything to contribute, please read on.

### Local development

Expand Down

0 comments on commit 5d8956b

Please sign in to comment.