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

Improved README #361

Merged
merged 4 commits into from
Sep 26, 2018
Merged

Improved README #361

merged 4 commits into from
Sep 26, 2018

Conversation

sdhutchins
Copy link
Contributor

I made some very subtle edits to the readme.

  • Added pip install information.
  • Truncated the list of metadata.

Added pip install information to README and made metadata bullet list smaller.
README.md Outdated
**This tool works only with Python 3.**
:heavy_exclamation_mark: **This tool works only with Python 3.**

`pip install spotdl`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please move this above the last paragraph of the "Installation" section.

For this command you should use block code, also for people who don't check the wiki let's make it pip3 directly:

$ pip3 install spotdl

vs

pip3 install spotdl

Otherwise, LGTM. Not sure what @ritiek thought about changing the list's appearance, I'm pretty sure we discussed this before; can't find it ATM.

Copy link
Member

@ritiek ritiek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. I'm fine with having displaying possible metadata fields in a single line. If anything, IMO it previously looked bloated. Thanks @sdhutchins!

@ritiek
Copy link
Member

ritiek commented Sep 22, 2018

I also pushed a note to check out the wiki page.

@sdhutchins
Copy link
Contributor Author

fyi, @linusg, this should be ready to merge whenever you have time.

@linusg linusg merged commit fe85211 into spotDL:master Sep 26, 2018
@linusg
Copy link
Contributor

linusg commented Sep 26, 2018

Right, thanks for the reminder and contribution of course!

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

Successfully merging this pull request may close these issues.

None yet

3 participants