play-dl-fix/README.md

51 lines
1.8 KiB
Markdown

# Why play-dl ?
[ytdl-core](https://github.com/fent/node-ytdl-core) has some issues with miniget and also stream abort issues. On the other hand, [youtube-dl](https://github.com/ytdl-org/youtube-dl) is a very perfect alternative but it takes time to launch. Hence, play-dl is created to avoid these issues along with providing comparatively faster performance than others.
[![Discord](https://img.shields.io/discord/888998674716315679?color=00ff00&label=%20Discord&logo=Discord)](https://discord.gg/8H3xWcv3D7)
## Support
You can contact us for support on our [chat server](https://discord.gg/8H3xWcv3D7)
## Stream videos/playlists or search for videos
This is a **light-weight** youtube downloader and searcher.
- searches by video, playlist, channel
- obtains audio playback url
### Installation
```bash
npm install play-dl@latest
```
### Importing
```ts
import * as play from 'play-dl' // ES-6 import or TS import
const play = require('play-dl') //JS importing
```
## Instructions
- 1.0 release change brings some code changes, make sure to read docs once again.
- [Spotify](https://github.com/play-dl/play-dl/discussions/64)
- [SoundCloud](https://github.com/play-dl/play-dl/discussions/92)
### Examples
- [YouTube](https://github.com/play-dl/play-dl/tree/main/examples/YouTube)
- [Spotify](https://github.com/play-dl/play-dl/tree/main/examples/Spotify)
- [SoundCloud](https://github.com/play-dl/play-dl/tree/main/examples/SoundCloud)
### Docs
- [Main](https://github.com/play-dl/play-dl/tree/main/docs#play-dl-commands)
- [YouTube](https://github.com/play-dl/play-dl/tree/main/docs/YouTube#youtube)
- [Spotify](https://github.com/play-dl/play-dl/tree/main/docs/Spotify#spotify)
- [SoundCloud](https://github.com/play-dl/play-dl/tree/main/docs/SoundCloud)
- [Deezer](https://github.com/play-dl/play-dl/tree/main/docs/Deezer)