PyDiscover icon indicating copy to clipboard operation
PyDiscover copied to clipboard

Published 20 hours ago • verified publisher icon cr0hn

Better documentation for module use

Open busybox11 opened this issue 5 years ago • 2 comments

This package is great, but it's not easy to use.

A better documentation to use this project as a module would be very appreciated. Also, more documentation in general (in code AND in the repo) would also be a great thing to have, and we'll habe an easier time trying to contribute to it.

busybox11 avatar Oct 08 '20 08:10 busybox11

What is exactly you need more doc? I have little time I would like invert it optimally. Thx

cr0hn avatar Oct 08 '20 08:10 cr0hn

I'd need more documentation about how to use the project as a module for my project (I'm experimenting websockets, it'll be a self-hosted server and a bunch of clients, which will be able to discover available servers on the local network). SInce there's not much documentation in the code and none at all in the README, it's kinda hard to use.

busybox11 avatar Oct 08 '20 16:10 busybox11