search

CXuesong / WikiClientLibrary

/*🌻*/ Wiki Client Library is an asynchronous MediaWiki API client library targeting modern .NET platforms
https://github.com/CXuesong/WikiClientLibrary/wiki
Apache License 2.0
82 stars 16 forks source link

Update documentation #16

Open HarelM opened 7 years ago

HarelM commented 7 years ago

Hi,

Can you please update documentation? The following is incorrect: var site = await WikiSite.CreateAsync(wikiClient, "https://test2.wikipedia.org/w/api.php"); Should be (I hope) var site = await Site.CreateAsync(wikiClient, "https://test2.wikipedia.org/w/api.php");

Also would be helpful to provide more example of API usage, for example, I want to use this library to upload images, but I'm not sure how to do it from the documentation.

CXuesong commented 7 years ago

Ooooops. It's my fault…… There are some renaming involved in v0.6-int pre-releases. Since then I have paused the development process for a while and didn't have enough time to update README to reflect all of these changes. While actually I suggest you to try the latest pre-release, the current example given on README is a a mixture of v0.5 and v0.6. Still, if you continue to use v0.5, here is a documentation for that version.

I begin to realize it's important to update the documentation to reflect the changes on the class names from v0.5 to v0.6-int; thus I will close this issue when the documentation has been properly updated.

HarelM commented 7 years ago

No Problem, Thanks for the quick response! I really don't want to write yet another wiki client and other C# libraries seems extremely outdated, do If you don't mind I'll open up issues here to let you know what issues I find when trying to use this client.

CXuesong commented 7 years ago

Oh, that would be really, really helpful! I will make use of my intermittent time windows to handle these. After all, it's a v0.x library :-P

CXuesong commented 7 years ago

Updated README in 5c9eaa5edc586f407bbb54d7afd7acc75b03522f. Now it reflects the changes of class names.