search

sealedtx / java-youtube-downloader

Simple, almost zero-dependency java parser for retrieving youtube video metadata
Other
413 stars 115 forks source link

document your api? #45

Open Twapa opened 4 years ago

Twapa commented 4 years ago

please document to see what is happening under the hood

Shabinder commented 4 years ago

+1

sealedtx commented 4 years ago

@Twapa @Shabinder hi guys, what exactly docs do you want to see here? This library is not really complicated and 1 page of usage examples in README should be enough for now, IMHO. In fact I have plans to refactor the whole library (class naming, package structure, interfaces, because now some of them are counterintuitive) and after that I may think about creating simple wiki.

Twapa commented 4 years ago

alright that will be great

barbetb commented 2 years ago

I've implemented the 2.x.x library, is there some documentation how to migrate to the 3.x.x library? I tried to compile with the 3.x.x and then see if I could fix the errors, but the refactoring is quite major, so most of the code is broken now. Some documentation would be nice.

@sealedtx Thanks again for this wonderful library. Up to today its working fantastic. Keep up the good work.

sealedtx commented 2 years ago

@barbetb hi, there is no migration documentation, because 3.x.x contains lot of major changes and completely changing extraction and downloading API. The only documentation for now – Usage section in README. You may compare it with 2.x.x Usage