Update README.md header #3251

davidedistefano · 2019-07-03T16:19:26Z

This PR updates the README.md layout visually, adding the full Solidus logo, improving the header and the Open Collective section.

Description
This PR could be the first of many improvements to this project README.md, like for example adding admin screenshots or a good project description.

Checklist:

I have followed Pull Request guidelines
I have added a detailed description into each commit message
I have updated Guides and README accordingly to this change (if needed)
I have added tests to cover this change (if needed)

tvdeyen

The GitHub preview is not the only way of viewing this file. I am 👎 for this change.

tvdeyen · 2019-07-03T17:16:16Z

README.md

+
+<p align="center">
+  <strong>A free, open-source ecommerce platform that gives you complete control over your store.</strong>
+</p>


I am not a fan of using more and more html in our readme file. First it is a markdown file and secondary this file is also meant to be read in an editor or terminal. Please do not see the GitHub preview as the single way to view this file.

jacobherrington

I think this looks really good in GitHub and I think it makes it a lot easier to find relevant information.

I do share Thomas' concern, however, that this file is not exclusively seen in GitHub.

davidedistefano · 2019-07-04T12:58:58Z

@tvdeyen @jacobherrington I understand your concern, but I think it's a matter of choice which kind of users to please when we talk about a README file, whether editor/terminal users or GitHub users. I know the first choice is more dev-friendly, but a lot of people use GitHub, and in my opinion, a good-looking README is good for the success of the platform. In fact, many successful projects, such as Vue.js, have a hybrid (HTML/markdown) file.

By the way, this is not a crucial change for now, and we can find a compromise, but I think, in the future, we should have more flexibility in terms of how to update the README, such as adding new content like images (which are not displayed in the editor/terminal) and sponsors logos.

tvdeyen · 2019-07-04T16:56:35Z

@davidedistefano the GitHub readme is not a marketing page. We have a nice looking site for this.

a good-looking README is good for the success of the platform

A good looking readme is possible with plain markdown. Centering text is personal taste and does neither decide over the success of this plattform nor lead to a better looking readme.

kennyadsl · 2019-07-08T14:21:20Z

IMHO, the README is part of the marketing material, especially if the target of the thing to market is mostly made by developers. We can argue that some developers use the README in the editor and not via GitHub, but honestly, I only have my intuition here, no real data.

Anyway, I think Thomas represents a part of users that prefer not to see HTML code in the README and we should listen to this feedback.

I suppose that centering text is something that we can easily change, probably a nice-looking table with partners images is more concerning, right @davidedistefano?

davidedistefano · 2019-07-10T11:59:44Z

I removed the HTML tags where possible in favor of markdown.

kennyadsl

Thanks, @davidedistefano!

ericsaupe

LGTM, I agree with @tvdeyen and would prefer little to not HTML in the README but this looks fine to me.

jacobherrington

I like this as well, but we shouldn't merge it without @tvdeyen weighing in on it at its current state.

WDYT Thomas?

tvdeyen

I am pretty sure we can get rid of HTML in favor of markdown for the linked images

tvdeyen · 2019-07-16T11:55:14Z

README.md

-Thank you to all our donors! 🙏 [Become a donor](https://opencollective.com/solidus#backer)
+<a href="https://nebulab.it/" target="_blank">
+  <img width="240px" src="https://nebulab.it/assets/images/public/logo.svg">
+</a>


Like with the status badges should also be writable as:

[![Nebulab](https://nebulab.it/assets/images/public/logo.svg)](https://nebulab.it/)

tvdeyen · 2019-08-07T21:29:05Z

README.md

-<a href="https://www.enginecommerce.com/"><img src="https://images.opencollective.com/proxy/images?src=https%3A%2F%2Flogo.clearbit.com%2Fenginecommerce.com&height=100"></a>
-<a href="https://supergood.software/"><img src="https://images.opencollective.com/proxy/images?src=https%3A%2F%2Fopencollective-production.s3-us-west-1.amazonaws.com%2F3bbb1440-727f-11e9-a366-37673cc38cee.png&height=100"></a>
-<a href="https://karmacreative.io/"><img src="https://images.opencollective.com/proxy/images?src=https%3A%2F%2Fopencollective-production.s3-us-west-1.amazonaws.com%2Fab94d2a0-7253-11e9-a366-37673cc38cee.png&height=100"></a>
+|<a href="https://www.enginecommerce.com/" target="_blank"><img src="https://images.opencollective.com/proxy/images?src=https%3A%2F%2Flogo.clearbit.com%2Fenginecommerce.com&height=100"></a>|<a href="https://supergood.software/" target="_blank"><img src="https://images.opencollective.com/proxy/images?src=https%3A%2F%2Fopencollective-production.s3-us-west-1.amazonaws.com%2F3bbb1440-727f-11e9-a366-37673cc38cee.png&height=100"></a>|<a href="https://karmacreative.io/" target="_blank"><img src="https://images.opencollective.com/proxy/images?src=https%3A%2F%2Fopencollective-production.s3-us-west-1.amazonaws.com%2Fab94d2a0-7253-11e9-a366-37673cc38cee.png&height=100"></a>|


These should also be writable as markdown. HTML should not be necessary

kennyadsl · 2019-08-09T16:22:00Z

@tvdeyen we can reduce HTML further in favor or Markdown but some images need to be resized (they are SVG) and it cannot be done with GitHub markdown, unfortunately. Do you have any suggestion?

tvdeyen · 2019-08-09T16:26:14Z

@kennyadsl the Nebulab logo could have a viewport in the svg with the correct size and therefore will not need a size attibute on the img tag. See http://tutorials.jenkov.com/svg/svg-viewport-view-box.html

davidedistefano · 2019-08-12T17:21:03Z

Now everything is written in Markdown except for the Solidus logo, which was already written in HTML.

tvdeyen

Thanks for being patient with me. 👍

This update improves the README.md layout visually, adding the full Solidus logo, improving the header and the Open Collective section.

…-readme Update README.md header Co-authored-by: jacobherrington <jacobherringtondeveloper@gmail.com>

tvdeyen requested changes Jul 3, 2019

View reviewed changes

jacobherrington reviewed Jul 3, 2019

View reviewed changes

kennyadsl approved these changes Jul 10, 2019

View reviewed changes

ericsaupe approved these changes Aug 7, 2019

View reviewed changes

jacobherrington approved these changes Aug 7, 2019

View reviewed changes

tvdeyen reviewed Aug 7, 2019

View reviewed changes

tvdeyen approved these changes Aug 12, 2019

View reviewed changes

davidedistefano force-pushed the davidedistefano/update-readme branch from 7c8ea0b to 56deee8 Compare August 13, 2019 09:40

davidedistefano added 4 commits August 13, 2019 11:46

Update README.md header

9ec02fb

This update improves the README.md layout visually, adding the full Solidus logo, improving the header and the Open Collective section.

Remove HTML tags where possibe using markdown instead

97ebc05

Use markdown for the Key Stakeholder table

b8d7009

Use markdown for contributors logos

fa86a23

davidedistefano force-pushed the davidedistefano/update-readme branch from 56deee8 to fa86a23 Compare August 13, 2019 09:47

kennyadsl merged commit d2c71a6 into solidusio:master Aug 13, 2019

kennyadsl deleted the davidedistefano/update-readme branch August 13, 2019 10:04

jacobherrington added a commit to jacobherrington/solidus that referenced this pull request Aug 14, 2019

Merge pull request solidusio#3251 from nebulab/davidedistefano/update…

b8ac82b

…-readme Update README.md header Co-authored-by: jacobherrington <jacobherringtondeveloper@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update README.md header #3251

Update README.md header #3251

davidedistefano commented Jul 3, 2019

tvdeyen left a comment

tvdeyen Jul 3, 2019

jacobherrington left a comment

davidedistefano commented Jul 4, 2019 •

edited

Loading

tvdeyen commented Jul 4, 2019

kennyadsl commented Jul 8, 2019

davidedistefano commented Jul 10, 2019

kennyadsl left a comment

ericsaupe left a comment

jacobherrington left a comment

tvdeyen left a comment

tvdeyen Jul 16, 2019

tvdeyen Aug 7, 2019

kennyadsl commented Aug 9, 2019

tvdeyen commented Aug 9, 2019 •

edited

Loading

davidedistefano commented Aug 12, 2019

tvdeyen left a comment

Update README.md header #3251

Update README.md header #3251

Conversation

davidedistefano commented Jul 3, 2019

tvdeyen left a comment

Choose a reason for hiding this comment

tvdeyen Jul 3, 2019

Choose a reason for hiding this comment

jacobherrington left a comment

Choose a reason for hiding this comment

davidedistefano commented Jul 4, 2019 • edited Loading

tvdeyen commented Jul 4, 2019

kennyadsl commented Jul 8, 2019

davidedistefano commented Jul 10, 2019

kennyadsl left a comment

Choose a reason for hiding this comment

ericsaupe left a comment

Choose a reason for hiding this comment

jacobherrington left a comment

Choose a reason for hiding this comment

tvdeyen left a comment

Choose a reason for hiding this comment

tvdeyen Jul 16, 2019

Choose a reason for hiding this comment

tvdeyen Aug 7, 2019

Choose a reason for hiding this comment

kennyadsl commented Aug 9, 2019

tvdeyen commented Aug 9, 2019 • edited Loading

davidedistefano commented Aug 12, 2019

tvdeyen left a comment

Choose a reason for hiding this comment

davidedistefano commented Jul 4, 2019 •

edited

Loading

tvdeyen commented Aug 9, 2019 •

edited

Loading