search

LSchallot / JellyRoller

CLI Jellyfin Controller Utility for Linux and Windows
GNU General Public License v2.0
48 stars 3 forks source link

Add examples in readme documentation for usage (enhancement) #16

Closed d8f6 closed 1 year ago

d8f6 commented 1 year ago

There are two things that were not immediately apparent to me and adding them to the readme would be helpful in my opinion.

  1. Upon initial sign-in, url has to include http/https (and port?, not sure as I included port), an example of this would be http://192/168.0.123:8096 I figured it out relatively quickly, but I thought maybe the program didn't work at first.

  2. Forward slash is needed to execute tasks with spaces in the name (example: jellyroller execute-task-by-name Scan\ Media\ Library). I tried quotes at first (jellyroller execute-task-by-name "Scan Media Library"), but that did not work. This is on a GNU/Linux host system, I am unsure of how Windows handles this as I do not use that software.

LSchallot commented 1 year ago

I will update the documentation with some additional clarification to address both Windows and Linux users. As far as the port is concerned, that is left up to how the end-user has their instance setup. For example, I have my primary Jellyfin behind a proxy so I do not need a port in my address; while my test instance requires use of a specified port.

d8f6 commented 1 year ago

Well maybe some clarity on the proxy vs local instance then? What threw me was actually http://192.168.0.23 vs just 192.168.0.23 though (as opposed to the trailing port number in the ip address). After getting frustrated I just guessed using http:// might work.

LSchallot commented 1 year ago

I added some clarification to the README.md that will hopefully make things a little clearer. Thanks again for the issue.

d8f6 commented 1 year ago

Thank you for the update.