Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Polish the readme based on feedback #151

Open
hnarayanan opened this issue Apr 30, 2021 · 2 comments
Open

Polish the readme based on feedback #151

hnarayanan opened this issue Apr 30, 2021 · 2 comments
Assignees

Comments

@hnarayanan
Copy link
Owner

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.

@hnarayanan hnarayanan self-assigned this Apr 30, 2021
@davidem
Copy link

davidem commented May 15, 2021

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
Copy link
Owner Author

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. 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants