node-youtube-music - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

package.json

 {
   "name": "node-youtube-music",
   "description": "Unofficial YouTube Music API for Node.js",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "main": "dist/src/index.js",
@@ -6,0 +6,0 @@ "types": "dist/src/index.d.ts",

README.md

@@ -1,1 +0,51 @@
-# node-youtube-music: Unofficial YouTube Music API for Node.js
+<p align="center">
+    <img width="400" alt="typescript-starter dark logo" src="https://user-images.githubusercontent.com/16015833/103463862-d9ee3200-4d2f-11eb-96d2-e02f5a5c9637.png" style="max-width:100%;">
+
+<h2 align="center">
+    Unofficial YouTube Music API for Node.js
+</h2>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/node-youtube-music">
+    <img src="https://img.shields.io/npm/v/node-youtube-music.svg" alt="version" />
+  </a>
+  <a href="https://npmjs.org/package/node-youtube-music">
+    <img src="https://img.shields.io/npm/dm/node-youtube-music.svg" alt="downloads" />
+  </a>
+   <a href="https://packagephobia.now.sh/result?p=node-youtube-music">
+    <img src="https://packagephobia.now.sh/badge?p=node-youtube-music" alt="install size" />
+  </a>
+</p>
+
+## Get started
+
+```shell
+npm install node-youtube-music
+```
+
+or
+
+```shell
+yarn add node-youtube-music
+```
+
+## How to use
+
+```ts
+import ytMusic from 'node-youtube-music';
+
+const musics = await ytMusic.search('Never gonna give you up');
+
+const suggestions = ytMusic.getSuggestions(musics[0].youtubeId);
+```
+
+## Looking for contributors 👇
+
+- [ ] Search
+  - [x] Songs
+  - [ ] Artists
+  - [ ] Playlists
+  - [ ] Albums
+- [x] Suggestions from song ID
+- [ ] Playlist management (create, push, remove)
+- [ ] Library management

No alert changes

Improved metrics

Total package byte prevSize

14734

increased by11.61%

Number of package files

18

increased by5.88%

Number of lines in readme file

52

increased by2500%

No dependency changes