youtube-api - npm Package Compare versions

Comparing version 1.2.1 to 1.3.0

CONTRIBUTING.md

@@ -10,3 +10,3 @@ # :eight_spoked_asterisk: :stars: :sparkles: :dizzy: :star2: :star2: :sparkles: :dizzy: :star2: :star2: Contributing :star: :star2: :dizzy: :sparkles:  :star: :star2: :dizzy: :sparkles: :stars: :eight_spoked_asterisk:
  - First of all, open an issue in the repository, using the [bug tracker][1],
-   describing the contribution you'd like to make, the bug you found or any
+   describing the contribution you would like to make, the bug you found or any
    other ideas you have. This will help us to get you started on the right
@@ -16,7 +16,8 @@ foot.
  - If it makes sense, add the platform and software information (e.g. operating
-   system, Node.JS version etc), screenshots (so we can see what you're seeing).
+   system, Node.JS version etc.), screenshots (so we can see what you are
+   seeing).
 
- - It's recommended to wait for feedback before continuing to next steps. However,
-   if the issue is clear (e.g. a typo) and the fix is simple, you can continue
-   and fix it.
+ - It is recommended to wait for feedback before continuing to next steps.
+   However, if the issue is clear (e.g. a typo) and the fix is simple, you can
+   continue and fix it.
 
@@ -31,4 +32,5 @@ ## Fixing issues
 
- - If the project contains a `package.json` file add yourself in the
-   `contributors` array (if it doesn't exist, create it):
+ - If the project contains a `package.json` or a `bower.json` file add yourself
+   in the `contributors` array (or `authors` in the case of `bower.json`;
+   if the array does not exist, create it):
 
@@ -38,3 +40,3 @@ ```json
       "contributors": [
-         "Your Name <[e-mail]> (http://your.website)
+         "Your Name <[e-mail]> (http://your.website)"
       ]
@@ -47,7 +49,7 @@ }
  - Open a pull request, and reference the initial issue in the pull request
-   message (e.g. *fixes #<your-issue-number*). Write a good description and
+   message (e.g. *fixes #<your-issue-number>*). Write a good description and
    title, so everybody will know what is fixed/improved.
 
- - If it makes sense, add screenshots, gifs etc, so it's easier to see what's
-   going on.
+ - If it makes sense, add screenshots, gifs etc., so it is easier to see what
+   is going on.
 
@@ -61,2 +63,3 @@ ## Wait for feedback
 Finally, your contributions will be merged, and everyone will be happy! :smile:
+Contributions are more than welcome!
 
@@ -66,2 +69,3 @@ Thanks! :sweat_smile:
 [1]: https://github.com/IonicaBizau/youtube-api/issues
+
 [2]: https://github.com/IonicaBizau/code-style

package.json

 {
   "name": "youtube-api",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "A Node.JS module, which provides an object oriented wrapper for the Youtube v3 API.",
   "main": "lib/index.js",
-  "author": "IonicaBizau <[e-mail]>",
+  "author": "Ionică Bizău <[e-mail]> (http://ionicabizau.net)",
   "contributors": [
@@ -25,3 +25,3 @@ "Ionică Bizău <[e-mail]>",
   ],
-  "license": "KINDLY",
+  "license": "MIT",
   "bugs": {
@@ -40,3 +40,74 @@ "url": "https://github.com/IonicaBizau/youtube-api/issues"
     "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "blah": {
+    "show_jsdocs": false,
+    "documentation": [
+      "The [official Youtube documentation](https://developers.google.com/youtube/v3/docs/) is a very useful resource.",
+      {
+        "ul": [
+          "[Activities](https://developers.google.com/youtube/v3/docs/activities)",
+          "[ChannelBanners](https://developers.google.com/youtube/v3/docs/channelBanners)",
+          "[Channels](https://developers.google.com/youtube/v3/docs/channels)",
+          "[GuideCategories](https://developers.google.com/youtube/v3/docs/guideCategories)",
+          "[PlaylistItems](https://developers.google.com/youtube/v3/docs/playlistItems)",
+          "[Playlists](https://developers.google.com/youtube/v3/docs/playlists)",
+          "[Search](https://developers.google.com/youtube/v3/docs/search)",
+          "[Subscriptions](https://developers.google.com/youtube/v3/docs/subscriptions)",
+          "[Thumbnails](https://developers.google.com/youtube/v3/docs/thumbnails)",
+          "[VideoCategories](https://developers.google.com/youtube/v3/docs/videoCategories)",
+          "[Videos](https://developers.google.com/youtube/v3/docs/videos)"
+        ]
+      },
+      "If you have any questions, just [open an issue](https://github.com/IonicaBizau/youtube-api/issues/new).",
+      {
+        "h3": "Authentication"
+      },
+      {
+        "h4": "OAuth (Access Token)"
+      },
+      {
+        "code": {
+          "language": "js",
+          "content": [
+            "Youtube.authenticate({",
+            "    type: \"oauth\"",
+            "  , token: \"your access token\"",
+            "});"
+          ]
+        }
+      },
+      {
+        "h4": "OAuth (Refresh Token)"
+      },
+      {
+        "code": {
+          "language": "js",
+          "content": [
+            "Youtube.authenticate({",
+            "    type: \"oauth\"",
+            "  , refresh_token: \"your refresh token\"",
+            "  , client_id: \"your client id\"",
+            "  , client_secret: \"your client secret\"",
+            "  , redirect_url: \"your refresh url\"",
+            "});"
+          ]
+        }
+      },
+      {
+        "h4": "Server Key"
+      },
+      "Only for requests that don't require [user authorization](https://developers.google.com/youtube/v3/guides/authentication) (certain list operations)",
+      {
+        "code": {
+          "language": "js",
+          "content": [
+            "Youtube.authenticate({",
+            "    type: \"key\"",
+            "  , key: \"your server key\"",
+            "});"
+          ]
+        }
+      }
+    ]
   }
 }

README.md

@@ -1,22 +0,5 @@
-<!---------------------------------------------------------------------------->
-<!-- STOP, LOOK & LISTEN!                                                   -->
-<!-- ====================                                                   -->
-<!-- Do NOT edit this file directly since it's generated from a template    -->
-<!-- file, using https://github.com/IonicaBizau/node-blah                   -->
-<!--                                                                        -->
-<!-- If you found a typo in documentation, fix it in the source files       -->
-<!-- (`lib/*.js`) and make a pull request.                                  -->
-<!--                                                                        -->
-<!-- If you have any other ideas, open an issue.                            -->
-<!--                                                                        -->
-<!-- Please consider reading the contribution steps (CONTRIBUTING.md).      -->
-<!-- * * * Thanks! * * *                                                    -->
-<!---------------------------------------------------------------------------->
+# youtube-api [![Support this project][donate-now]][paypal-donations]
 
-# youtube-api [![Donate now][donate-now]][paypal-donations]
-
 A Node.JS module, which provides an object oriented wrapper for the Youtube v3 API.
 
-[![NPM](https://nodei.co/npm/youtube-api.png?downloads=true)](https://nodei.co/npm/youtube-api/)
-
 ## Installation
@@ -30,5 +13,2 @@
 
-You may be interested to download [this test application](https://github.com/IonicaBizau/test-youtube-api)
-and play with the YouTube API resources there. Below you see an example how to use the library.
-
 ```js
@@ -113,3 +93,2 @@ /**
 });
-
 ```
@@ -134,5 +113,3 @@
 If you have any questions, just [open an issue](https://github.com/IonicaBizau/youtube-api/issues/new).
-
 ### Authentication
-
 #### OAuth (Access Token)
@@ -145,3 +122,2 @@ ```js
 ```
-
 #### OAuth (Refresh Token)
@@ -157,5 +133,4 @@ ```js
 ```
-
 #### Server Key
-*Only for requests that don't require [user authorization](https://developers.google.com/youtube/v3/guides/authentication) (certain list operations)*
+Only for requests that don't require [user authorization](https://developers.google.com/youtube/v3/guides/authentication) (certain list operations)
 ```js
@@ -171,11 +146,36 @@ Youtube.authenticate({
 
+## Where is this library used?
+If you are using this library in one of your projects, add it in this list. :sparkles:
+
+ - [`anitube`](https://github.com/temperman/animeClowler) by kikura-yuichiro
+
+ - [`kyot-sunday-playlists`](https://github.com/apandichi/kyot-sunday-playlists) by Alin Pandichi
+
+ - [`mediacenterjs`](http://www.mediacenterjs.com) by Jan Smolders
+
+ - [`node-red-node-youtube`](https://github.com/jlong23/node-red-node-youtube#readme) by Jay Long
+
+ - [`node-youtubeapi-simplifier`](https://github.com/Haidy777/node-youtubeAPI-simplifier) by Haidy777
+
+ - [`pullplaylist`](https://github.com/sameid/pullplaylist) by Sameid Usmani
+
+ - [`pully`](https://github.com/JimmyBoh/pully#readme) by Jim Buck
+
+ - [`steam-chat-bot`](https://steam-chat-bot.github.io/node-steam-chat-bot) by See contributors
+
+ - [`test-youtube-api`](https://github.com/IonicaBizau/test-youtube-api) by Ionică Bizău
+
+ - [`youtube-vanitystats`](https://npmjs.com/package/youtube-vanitystats) by Sebastian Patten
+
 ## License
-[KINDLY][license] © [Ionică Bizău][website]–The [LICENSE](/LICENSE) file contains
-a copy of the license.
 
-[license]: http://ionicabizau.github.io/kindly-license/?author=[e-mail]%3E&year=2015
+[KINDLY][license] © [Ionică Bizău][website]
+
+[license]: http://ionicabizau.github.io/kindly-license/?author=[e-mail]%3E&year=2013
+
+[website]: http://ionicabizau.net
+[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
+[donate-now]: http://i.imgur.com/6cMbHOC.png
+
 [contributing]: /CONTRIBUTING.md
-[website]: http://ionicabizau.net
-[docs]: /DOCUMENTATION.md
-[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MG98D7NPFZ3MG
-[donate-now]: http://i.imgur.com/jioicaN.png
+[docs]: /DOCUMENTATION.md

New alerts

SPDX disjunction

License

SPDX disjunction for an artifact's license information

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Non-permissive License

License

(Experimental) A license not known to be considered permissive was found

Found 1 instance in 1 package

Fixed alerts

SPDX disjunction

License

SPDX disjunction for an artifact's license information

Found 1 instance in 1 package

Non-permissive License

License

(Experimental) A license not known to be considered permissive was found

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

18171

decreased by-15.17%

Number of package files

8

decreased by-11.11%

Number of low license alerts

4

increased by33.33%

No dependency changes