diff --git a/README.md b/README.md index 85dc1bd6..ca2fd52d 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,55 @@ -

YouTube.js

+ + +

+ YouTube.js +

- A full-featured wrapper around the Innertube API, which is what YouTube itself uses. -

+ + + A full-featured wrapper around the Innertube API, which is what YouTube itself uses. + +

- Report Bug + + + Report Bug + ยท - Request Feature -
-
+ + Request Feature + + +
+
- - - - - - - - -
- - - + + + Tests + + + + Latest version + + + + Code factor + + + + Monthly downloads + + + + + +
+ + + + Donate +

@@ -118,9 +145,20 @@ const youtube = await new Innertube({ gl: 'US' }); // all parameters are optiona ### A simple search: -Client: `YOUTUBE` | `YTMUSIC` +Options: + * client: `YOUTUBE` | `YTMUSIC` + + * filters (youtube only): + * upload_date: `any` | `last_hour` | `today` | `this_week` | `this_month` | `this_year` + + * type: `any` | `video` | `channel` | `playlist` | `movie` + + * duration: `any` | `short` | `medium` | `long` + + * sort_by: `relevance` | `rating` | `upload_date` | `view_count` + ```js -const search = await youtube.search('Looking for life on Mars - Documentary', { client: 'YOUTUBE' }); +const search = await youtube.search('QUERY', { client: 'YOUTUBE' }); ```
@@ -678,7 +716,7 @@ const playlist = await youtube.getPlaylist('PLAYLIST_ID', { client: 'YOUTUBE' }) ```
-YouTube Output + YouTube Output

```js @@ -709,7 +747,7 @@ const playlist = await youtube.getPlaylist('PLAYLIST_ID', { client: 'YOUTUBE' })

-YouTube Music Output + YouTube Music Output

```js @@ -1151,4 +1189,6 @@ Should you have any questions or concerns please contact me directly via email. ## License Distributed under the [MIT](https://choosealicense.com/licenses/mit/) License. -

(back to top)

\ No newline at end of file +

+ (back to top) +

\ No newline at end of file