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
Add logo to README, and make intro it look a little nicer #2003
Conversation
@xPaw, I really gave a chance to the Also I really wanted to give a shot at / but I think it doesn't look good (well, the Travis one, at least), and it would be weird if only those 2 had logo. We can use Unicode but meh. |
0b5252b
to
3a5b8ff
Compare
Damn that's a lot of badges. I would prefer if they fit on 1 or 2 lines at most.
Don't think it's a good idea to put ampersands in URLs like that. I think all the logos should be added to an assets/logos folder, so they all can be seen. And then the ones client uses copied and optimized (with svgo) separately. |
It's "only" 3 badges more than what we have. You should see it as 2 lines though, the first line is just the freenode channel, to emphasize on it. Overall, it makes for something rather balanced and nice, I think, not overwhelmed by badges: The 3 logos I added are the Node.js version supported, MIT license, and total downloads. Of course, none of those are mandatory, I just thought they were informative enough to go there. Node version, for example, especially since we're changing it in v3... License is meh, downloads is a nice pat in the back, but not vital I agree :) With the current badges, on a single line (again, not counting the freenode channel as its own line), it gives: With Node version as only extra badge: What do you think? I'm fine with any of those 3, and don't want to overthink this lol, just make it look nice :)
Oh yeah absolutely. I should have added a todo item about this, because it's not what I want to ship, I was just doing the overall shape at that point. |
I like the way you have it - does feel balanced and clean |
@xPaw, we need to decide which file(s) we want to add to this repo. I'm adding everything as provided to the website repo, but this one should only contain a curated version, i.e. not the .ai files, not the brand guidelines, etc. I figured I didn't have to do this just now, so finished the README first, but happy to hear thoughts. |
@astorije I think second screenshot is the best. Having too many badges (especially static ones) is just too noisy. We could probably add downloads badge into that (instead of node version). And change green color to something else so it doesn't collide with builds. |
5f4a033
to
42abe46
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Image needs renaming though.
@xPaw, changed, see result below. I'm actually changing my mind on downloads, since over time the npm might not be the prime way to install / download The Lounge: it will be better to do it via your OS package manager. |
@astorije That's true, although that still gives us some popularity metric. |
Ahah yeah, nevermind: https://img.shields.io/github/downloads/thelounge/lounge/total.svg (not documented at the moment though). |
b8b375b
to
b637f50
Compare
Updated the name of the image, and optimized it with
Any suggestion for the tag line? :) |
😩 |
@astorije perhaps background-color:transparent can be specified in the svg? EDIT: It's github's fault. They set |
<img | ||
width="300" | ||
alt="The Lounge" | ||
src="client/img/logo-vertical-transparent-bg.svg"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This could link to image from website repository.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I hesitated between link to the main website or nothing, and went for nothing because it's just too random :) Plus we already have a link to the website underneath. But link to the website repo, I'm not a fan, it's plain weird
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I meant image link
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, right, but it's already a link to the image (within this repo) so 🤷♂️
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We wouldn't have to track the logo separately in this repo, just like we don't do it for the screenshot.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh wow, I realize I totally misread what you meant from the beginning. I get it now.
I'm going to use that same image file in the app itself, so I'd have to add it anyway.
README.md
Outdated
@@ -18,10 +66,6 @@ Modern web IRC client designed for self-hosting. | |||
|
|||
To learn more about configuration, usage and features of The Lounge, take a look at [the website](https://thelounge.github.io). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change the url here.
b637f50
to
c83a86d
Compare
cddfe69
to
ca8df65
Compare
Improve our lame tag line 😅LaterUpdate screenshotLater<h3>
/</h2>
View the result here
Ideas welcome :)