java-youtube-downloader icon indicating copy to clipboard operation
java-youtube-downloader copied to clipboard

Published 20 hours ago • verified publisher icon sealedtx

document your api?

Open Twapa opened this issue 4 years ago • 5 comments

please document to see what is happening under the hood

Twapa avatar Aug 22 '20 22:08 Twapa

+1

Shabinder avatar Aug 23 '20 11:08 Shabinder

@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.

sealedtx avatar Aug 23 '20 17:08 sealedtx

alright that will be great

Twapa avatar Aug 23 '20 21:08 Twapa

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.

barbetb avatar Nov 05 '21 23:11 barbetb

@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

sealedtx avatar Nov 06 '21 07:11 sealedtx