Skip to content

Commit

Permalink
Some changes to fix Markdown on npmjs.com (maybe?)
Browse files Browse the repository at this point in the history
  • Loading branch information
Haidy777 committed Sep 4, 2015
1 parent eb654ac commit 83e685a
Showing 1 changed file with 20 additions and 22 deletions.
42 changes: 20 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
#node-youtubeAPI-simplifier
[![NPM](https://nodei.co/npm/node-youtubeapi-simplifier.png)](https://www.npmjs.com/package/node-youtubeapi-simplifier)

# node-youtubeAPI-simplifier
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 :)

I already implemented a bunch of functions regarding channels, playlists and (a basic & simple) video search.

Examples can be found in the examples directory and at the end of this readme.

##Contribute
## Contribute
Because my time for developing isn't unlimited Pull-Requests are always welcome, just look at my implementations and make yours look the same, so we have a little bit of readability and structure.

##Known Bugs
## Known Bugs
* There shouldn't be any.

##Example Usages
###ChannelFunctions
####Retrieving Details for an User
## Example Usages
### ChannelFunctions
#### Retrieving Details for an User
var ytapi = require('node-youtubeapi-simplifier');
ytapi.setup('YOUR API KEY');
ytapi.channelFunctions.getDetailsForUser('Youtube Username').then(function (data) {
Expand All @@ -31,14 +29,14 @@ Because my time for developing isn't unlimited Pull-Requests are always welcome,
console.log('Uploads Playlist: ' + data.uploadsPlaylist);
});

####Get the ChannelId for an User
#### Get the ChannelId for an User
var ytapi = require('node-youtubeapi-simplifier');
ytapi.setup('YOUR API KEY');
ytapi.channelFunctions.getChannelIdForUser('Youtube Username').then(function (data) {
console.log('ChannelId: ' + data.channelId);
});

####Get statistics for an User
#### Get statistics for an User
var ytapi = require('node-youtubeapi-simplifier');
ytapi.setup('YOUR API KEY');
ytapi.channelFunctions.getStatisticsForUser('Youtube Username').then(function (data) {
Expand All @@ -48,48 +46,48 @@ Because my time for developing isn't unlimited Pull-Requests are always welcome,
console.log('Videos: ' + data.videoCount);
});

###PlaylistFunctions
####Get a list of playlists for an User
#####All (without Limitations - Warning: Can take long!)
### PlaylistFunctions
#### Get a list of playlists for an User
##### All (without Limitations - Warning: Can take long!)
var ytapi = require('node-youtubeapi-simplifier');
ytapi.setup('YOUR API KEY');
ytapi.playlistFunctions.getPlaylistsForUser('Youtube Username').then(function (data) {
console.log(data);
});
#####Limited to a specified amount (in this case: 10)
##### Limited to a specified amount (in this case: 10)
var ytapi = require('node-youtubeapi-simplifier');
ytapi.setup('YOUR API KEY');
ytapi.playlistFunctions.getPlaylistsForUser('Youtube Username', 10).then(function (data) {
console.log(data);
});
####Get a list of Videos for a playlist
#####All (without Limitations - Warning: Can take long!)
#### Get a list of Videos for a playlist
##### All (without Limitations - Warning: Can take long!)
var ytapi = require('node-youtubeapi-simplifier');
ytapi.setup('YOUR API KEY');
ytapi.playlistFunctions.getVideosForPlaylist('PlaylistID').then(function (data) {
console.log(data);
});
#####Limited to a specified amount (in this case: 10)
##### Limited to a specified amount (in this case: 10)
var ytapi = require('node-youtubeapi-simplifier');
ytapi.setup('YOUR API KEY');
ytapi.playlistFunctions.getVideosForPlaylist('PlaylistID', 10).then(function (data) {
console.log(data);
});
###SearchFunctions
####Simple Search (always returns first 50 Elements | might change)
### SearchFunctions
#### Simple Search (always returns first 50 Elements | might change)
var ytapi = require('node-youtubeapi-simplifier');
ytapi.setup('YOUR API KEY');
ytapi.searchFunctions.simpleSearch('Search String').then(function (data) {
console.log(data);
});
####Channel Internal Search
#####All (without Limitations - Warning: Can take long!)
#### Channel Internal Search
##### All (without Limitations - Warning: Can take long!)
var ytapi = require('node-youtubeapi-simplifier');
ytapi.setup('YOUR API KEY');
ytapi.searchFunctions.channelInternalSearch('Youtube Username', 'Search String').then(function (data) {
console.log(data);
});
#####Limited to a specified amount (in this case: 10)
##### Limited to a specified amount (in this case: 10)
var ytapi = require('node-youtubeapi-simplifier');
ytapi.setup('YOUR API KEY');
ytapi.searchFunctions.channelInternalSearch('Youtube Username', 'Search String', 10).then(function (data) {
Expand Down

0 comments on commit 83e685a

Please sign in to comment.