From cefe3a6f2d88a0e5c6dcae5d9bc55c2b177df621 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ionic=C4=83=20Biz=C4=83u?= Date: Fri, 4 Jan 2019 12:12:39 +0200 Subject: [PATCH] Updated docs --- LICENSE | 2 +- README.md | 44 ++++++++++++++++++++++++++++++++++---------- package.json | 2 +- 3 files changed, 36 insertions(+), 12 deletions(-) diff --git a/LICENSE b/LICENSE index 5ae5eb3..147f6ce 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2013-17 Ionică Bizău (https://ionicabizau.net) +Copyright (c) 2013-19 Ionică Bizău (https://ionicabizau.net) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 8695b1a..8676251 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,20 @@ # youtube-api - [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/youtube-api.svg)](https://www.npmjs.com/package/youtube-api) [![Downloads](https://img.shields.io/npm/dt/youtube-api.svg)](https://www.npmjs.com/package/youtube-api) + [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/youtube-api.svg)](https://www.npmjs.com/package/youtube-api) [![Downloads](https://img.shields.io/npm/dt/youtube-api.svg)](https://www.npmjs.com/package/youtube-api) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github) + +Buy Me A Coffee > A Node.JS module, which provides an object oriented wrapper for the Youtube v3 API. ## :cloud: Installation ```sh -$ npm i --save youtube-api +# Using npm +npm install --save youtube-api + +# Using yarn +yarn add youtube-api ``` @@ -120,9 +126,11 @@ There are few ways to get help: 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question. 2. For bug reports and feature requests, open issues. :bug: + 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket: + ## :memo: Documentation The [official Youtube documentation](https://developers.google.com/youtube/v3/docs/) is a very useful resource. @@ -143,14 +151,18 @@ If you have any questions, please [ask them on **Stack Overflow**](https://stack ### Authentication + #### OAuth (Access Token) + ```js Youtube.authenticate({ type: "oauth" , token: "your access token" }); ``` + #### OAuth (Refresh Token) + ```js Youtube.authenticate({ type: "oauth" @@ -160,7 +172,9 @@ Youtube.authenticate({ , redirect_url: "your refresh url" }); ``` + #### Server Key + Only for requests that don't require [user authorization](https://developers.google.com/youtube/v3/guides/authentication) (certain list operations) ```js Youtube.authenticate({ @@ -169,17 +183,19 @@ Youtube.authenticate({ }); ``` + ## :yum: How to contribute Have an idea? Found a bug? See [how to contribute][contributing]. ## :sparkling_heart: Support my projects -I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, +I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it). However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it: + - Starring and sharing the projects you like :rocket: - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book: - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea: @@ -188,6 +204,7 @@ However, if you get some profit from this or just want to encourage me to contin ![](https://i.imgur.com/z6OQI95.png) + Thanks! :heart: @@ -197,37 +214,44 @@ If you are using this library in one of your projects, add it in this list. :spa - [`adasq-services-ytv`](https://github.com/adasq/adasq-services-ytv#readme)—It creates news feed from youtube search result, for specific queries - [`anitube`](https://github.com/temperman/animeClowler) (by kikura-yuichiro)—node module for getting youtube video url of japanese animation OP/ED movie + - [`botyo-command-youtube`](https://github.com/ivkos/botyo-command-youtube#readme) (by Ivaylo Stoyanov)—YouTube command for Botyo - [`chewb-youtube-uploader`](https://github.com/samradical/youtube-uploader) (by Sam Elie)—Wrapper tool around a great uploader. + - [`hpcbot`](https://github.com/hpcbot/hpcbot#readme) (by bdickason)—Twitch Bot for the Harry Potter Clan - [`kyot-sunday-playlists`](https://github.com/apandichi/kyot-sunday-playlists) (by Alin Pandichi)—Kyot Sunday Playlists - [`mediacenterjs`](http://www.mediacenterjs.com) (by Jan Smolders)—A NodeJS based mediacenter for your browser - [`mediacenterjs-youtube`](http://www.mediacenterjs.com) (by Jan Smolders)—A Youtube app for mediacenterjs - - [`muzier-cli`](https://github.com/kevin940726/muzier-cli#readme) (by Kai Hao)—The muzier command line interface. + - [`muzier-cli`](https://github.com/kevin940726/muzier-cli#readme) (by Kai Hao)—A command line interface to download mp3 from Youtube. - [`node-red-contrib-youtube`](https://github.com/StefanWerW/node-red-contrib-youtube#readme) (by scaw.dev)—Youtube nodes for node-red - [`node-red-node-youtube`](https://github.com/jlong23/node-red-node-youtube#readme) (by Jay Long)—A Node-RED node to access Youtube Data API. - [`node-youtubeapi-simplifier`](https://github.com/Haidy777/node-youtubeAPI-simplifier) (by Haidy777)—The Youtube-API probably isn't the simplest api in the world. So why isn't there a simplifier? Well, don't worry, now there is one :) + - [`osjs-youtube-adapter`](https://github.com/SpaceboyRoss01/osjs-youtube-adapter#readme) (by Spaceboy Ross)—The YouTube API wrapped as a VFS adapter in OS.js V3. - [`pullplaylist`](https://github.com/sameid/pullplaylist) (by Sameid Usmani)—Youtube video downloader in pure javascript. + - [`spotivy`](https://github.com/danguilherme/spotivy#readme) (by Guilherme Ventura)—Spotify music videos downloader - [`steam-chat-bot`](https://steam-chat-bot.github.io/node-steam-chat-bot) (by See contributors)—Simplified interface for a steam chat bot with lots of built-in functionality - [`test-youtube-api`](https://github.com/IonicaBizau/test-youtube-api)—Test Youtube API NodeJS module - [`ydown`](https://npmjs.com/package/ydown)—Downloads Youtube links and playlists (Audio only) - [`YouSlackBot`](https://npmjs.com/package/YouSlackBot) (by SoNiKBooM)—Insert Youtube videos posted to Slack into a Youtube playlist. - [`youtube-album-uploader`](https://github.com/jpchip/youtube-album-uploader) (by Jared Chapiewsky)—Uploads an mp3 album to Youtube + - [`youtube-album-uploader-multiple`](https://github.com/Chnapy/youtube-album-uploader-multiple) (by Richard Haddad)—Uploads multiple mp3 files to youtube - [`youtube-channel-videos`](https://github.com/almoore/youtube-channel-videos#readme) (by Alex Moore)—Youtube channel videos fetcher. + - [`youtube-comment-sampler`](https://npmjs.com/package/youtube-comment-sampler) (by krazyjakee@gmail.com)—Download 1000 relevant youtube comments for a youtube video to CSV - [`youtube-dler`](https://github.com/iguider/youtube-dler#readme) (by Ayoub Ider AGHBAL)—A command line tool to download youtube videos/audio and playlists - - [`youtube-playlist-info`](https://github.com/benkaiser/youtube-playlist-info) (by Benjamin Kaiser)—Youtube playlist information fetcher. + - [`youtube-playlist-info`](https://github.com/benkaiser/youtube-playlist-info#readme) (by Benjamin Kaiser)—Youtube playlist information fetcher. - [`youtube-vanitystats`](https://npmjs.com/package/youtube-vanitystats) (by Sebastian Patten)—A scheduled job that will will query YouTube's API for a given video ID. It will then email you the number of views and amount of revenue you have made since the last time it was run. ## :scroll: License [MIT][license] © [Ionică Bizău][website] -[badge_patreon]: http://ionicabizau.github.io/badges/patreon.svg -[badge_amazon]: http://ionicabizau.github.io/badges/amazon.svg -[badge_paypal]: http://ionicabizau.github.io/badges/paypal.svg -[badge_paypal_donate]: http://ionicabizau.github.io/badges/paypal_donate.svg + +[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg +[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg +[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg +[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg + [patreon]: https://www.patreon.com/ionicabizau [amazon]: http://amzn.eu/hRo9sIZ [paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW -[donate-now]: http://i.imgur.com/6cMbHOC.png [license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2013#license-mit [website]: https://ionicabizau.net diff --git a/package.json b/package.json index 46571fd..0504159 100644 --- a/package.json +++ b/package.json @@ -131,4 +131,4 @@ "bloggify.json", "bloggify/" ] -} \ No newline at end of file +}