search

devoxin / SharpLink

Lavalink wrapper for Discord.Net written in C#
MIT License
27 stars 6 forks source link

Documentation / Proper README #13

Open NovusTheory opened 6 years ago

NovusTheory commented 6 years ago

SharpLink needs a proper documentation / a better README that can document or some other means

NovusTheory commented 6 years ago

15 updated the README but I'm not going to close this quite yet.

devoxin commented 6 years ago

Perhaps GitHub Wikis could be put to use?

ghost commented 6 years ago

@Devoxin Please, and give more insight on how to use it and where to put the code

devoxin commented 6 years ago

cc @NovusTheory

NovusTheory commented 6 years ago

@xXFrostyXx Care to provide info on what's confusing to make it better?

ghost commented 6 years ago

@NovusTheory Maybe what files people should make, or where to place certain bits of code, possible error fixes, the basic stuff so that people like me (even though i have fixed my errors) have a place to go to for some answers. Maybe some basic commands we could add, basically the basics but in a more simpler way.

Yucked commented 6 years ago

I don't see why a wiki would be needed. The library isn't massive enough for it. Most of the method names are self explanatory, everything can be found via Visual studio's intellisense (Not sure if VSCode has it). Even if you do need a wiki or documentation, read through library's code there are 2-3 main files.