d4n3436 / GTranslate

A collection of free translation APIs (Google Translate, Bing Translator, Microsoft Translator and Yandex.Translate).
MIT License
69 stars 11 forks source link

Great project but it lacks documentation #6

Closed knowpwr closed 1 year ago

knowpwr commented 1 year ago

Hello. First of all, thanks a lot for this great project. It is one of the most understarred projects out there even though it delivers. The problem is that this project lacks documentation. I had to dig deep into the project to find what I want. The example provided is very limited. I suggest you work on the documentation or at least give examples of usage if you do not have the time. Give multiple examples on README page. How to specifically use Google service alone, for example. Give as much examples as you can to cover what the project offers.

Regards and thanks again.

d4n3436 commented 1 year ago

Hey. The library is fully documented with XML comments. Your IDE should provide information about the methods, classes and objects of the library through the editor and the debugger. You're right about the examples and I will provide more usage examples on the README soon.