Where to best introduce usage?

dbosk / canvaslms

Command-line interface to Canvas LMS

https://pypi.org/project/canvaslms/

MIT License

4 stars 2 forks source link

Where to best introduce usage? #187

Open dbosk opened 4 weeks ago

dbosk commented 4 weeks ago

Where would be the best location for introducing usage such as login? The README here on GitHub (and on PyPI, it's the same)? (@monperrus added that.) Maybe also in the intro to the PDF? Maybe also in the main help, i.e. canvaslms -h.

Where did you instinctively read @monperrus?

Originally posted by @dbosk in https://github.com/dbosk/canvaslms/issues/186#issuecomment-2450782949

dbosk commented 4 weeks ago

Well, once we have #77, that would also be a good location.

monperrus commented 4 weeks ago

the README is what I read, sequentially.