From f8737d60d98e1619ba2011e4b6c2b783f4900007 Mon Sep 17 00:00:00 2001 From: absidue <48293849+absidue@users.noreply.github.com> Date: Wed, 15 Dec 2021 17:09:57 +0100 Subject: [PATCH] Various README updates --- README.md | 38 ++++++++++++++++++++++++++++++-------- 1 file changed, 30 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c829265..0e7d73b 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,53 @@ # Play-dl - A **light-weight** youtube, soundcloud, spotify, deezer downloader and searcher. -- searches by video, playlist, channel -- obtains audio playback url +A **light-weight** YouTube, SoundCloud, Spotify and Deezer streaming and searching library. + +- Search by video, playlist/album, channel/artist +- Stream audio from YouTube and SoundCloud # 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. +[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 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) +[![Discord](https://img.shields.io/discord/888998674716315679?color=00aa00&label=%20Discord&logo=Discord)](https://discord.gg/8H3xWcv3D7) +[![NPM](https://img.shields.io/npm/v/badges.svg?color=00aa00&logo=npm)](https://www.npmjs.com/package/play-dl) ## Support -You can contact us for support on our [chat server](https://discord.gg/8H3xWcv3D7) +You can contact us for support on our [chat server](https://discord.gg/8H3xWcv3D7). ### Installation +**Node.js 16.0.0 or newer is required.** + ```bash npm install play-dl@latest +pnpm add play-dl@latest +yarn add play-dl@latest ``` ### Importing +**TypeScript:** ```ts -import * as play from 'play-dl' // ES-6 import or TS import +import play from 'play-dl'; // Everything -const play = require('play-dl') //JS importing +import { video_basic_info, stream } from 'play-dl'; // Individual functions +``` + +**CommonJS modules:** +```js +const play = require('play-dl'); // Everything + +// Individual functions by using destructuring +const { video_basic_info, stream } = require('play-dl'); +``` + +**ES6 modules:** +```ts +import * as play from 'play-dl'; // Everything + +import { video_basic_info, stream } from 'play-dl'; // Individual functions ``` ### [Documentation](https://play-dl.github.io/modules.html)