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

Added color swatches to README #24

Conversation

twolfson
Copy link
Contributor

While discussing #17 I was getting frustrated at not having a good point of reference for what colors were which in the UI. To resolve this, I have added color swatches to the README.

I wanted to use HTML with style="background" or SVG but it looks like GitHub scrubs those. Thankfully, I was able to find a workaround via Shields.io (a badge service).

selection_004

In this PR:

  • Added color swatches to README

/cc @gmusic-utils/gmusic-theme-js

@chrismou
Copy link
Member

Looking at it in photoshop, only a single pixel line of each colour block matches the hex code. It's essentially a gradient.

That said, it gives a fair idea of what they are and is a better reference than it was before, so just :shipit: if you're happy with it.

The only other option is to throw something together in photoshop and throw this PSD into the @gmusic-utils/meta. I could recreate those buttons with a solid colour in no time if you're bothered enough to wait an hour or so. Let me know.

@twolfson
Copy link
Contributor Author

It looks like we might have better luck with the flat-squared style:

http://shields.io/#styles

@twolfson
Copy link
Contributor Author

It's a less intense gradient but it's still there =(

https://img.shields.io/badge/%231ED760-%20%20%20-1ED760.svg?style=flat-squared

@twolfson
Copy link
Contributor Author

If we do go the Photoshop route, it's prob best for the images to live in this repo itself or wherever we store the screenshot in the README:

![](https://www.samuel.ninja/img/gpmdp_screen.gif)

In my repos, I typically make a docs folder for such content so it stays version controlled with the repo.

https://github.com/twolfson/google-music-electron/tree/2.9.0/docs

Meta is more for the gmusic-utils organization than being an asset folder.

@chrismou
Copy link
Member

I think the shields are probably fine. Like I say, it's just a reference and the hex codes are there. I doubt anyone will pull us up on the fact it doesn't default to the exact shade of green they were expecting from the visualisation 😄

@twolfson
Copy link
Contributor Author

Heh, here's to hoping 🍀

Going to wait on @MarshallOfSound before taking any actions on landing this PR (not sure I even can on npm)

@MarshallOfSound
Copy link
Member

LGTM 👍

I really need to give you guys NPM perms 😄

@twolfson
Copy link
Contributor Author

@MarshallOfSound Can you land/release this since I don't have npm permissions?

@MarshallOfSound
Copy link
Member

I just added you on NPM along with @chrismou

@twolfson
Copy link
Contributor Author

What's the release process? It looks like:

npm version
# For example: `npm version patch` to bump patch version

@MarshallOfSound
Copy link
Member

Yep, literally just

npm version patch
npm publish

Then don't forget to

git push && git push --tags

@twolfson
Copy link
Contributor Author

Cool, I will link the comment on #3

@twolfson twolfson mentioned this pull request Mar 12, 2016
@twolfson twolfson merged commit 1e70aa8 into gmusic-utils:master Mar 12, 2016
@twolfson
Copy link
Contributor Author

This has been merged/released in 1.0.17 🎉

@twolfson twolfson mentioned this pull request Mar 12, 2016
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.

3 participants