hnarayanan / shpotify

A command-line interface to Spotify.
https://harishnarayanan.org/projects/
2.02k stars 153 forks source link

Polish the readme based on feedback #151

Open hnarayanan opened 3 years ago

hnarayanan commented 3 years ago

I like that the README starts with a description of what the software is all about. I like that the copyright license is stated explicitly.

I would perhaps add a few words explaining what Spotify is, to save readers from having to follow a link. Not a big deal, though.

I would perhaps move the installation instructions to after the usage description. I'd prefer to get some idea of what the software is like to use before I worry about installing it.

davidem commented 3 years ago

To be honest: imho the readme is quite alright as it currently is šŸ˜Ž. Yes, you can explain 'spotify', but I think there aren't many people who don't know what spotify is. Perhaps you can add "audio streaming service" before the spotify link.

I think it is common to explain how to install software before explaining how to use it. You might explain a few of the possibilities of shpotify in the introduction, then talk about installation and then the detailed usage instructions. Or add a cool gif made with terminalizer as an introduction. šŸ˜

Cheers,

David

hnarayanan commented 3 years ago

Thank you. This is not my feedback, this is just me quoting a person who offered this service as a gesture. (They read READMEs knowing nothing about your project and offer their feedback.) Iā€™m not what parts of it I will act on if any. šŸ˜