Adds a fancy new README file #22
Conversation
README.md
Outdated
| </a> | ||
| </p> | ||
|
|
||
| <div align="center"> |
There was a problem hiding this comment.
Nit picking and opinionated a bit. Feel free to argue against this.
I prefer this:
<div align="center">
<a href="https://shopify.com/">Website</a>
<span> | </span>
<a href="https://polaris.shopify.com/">Styleguide</a>
<span> | </span>
<a href="http://github.com/Shopify/javascript-utilities/blob/master/CHANGELOG.md">Changelog</a>
</div>There was a problem hiding this comment.
I'm indifferent, tbh, although I should become opinionated.
My thoughts with the current styling are that it helps, in general, to spot and fix typos when the text is on its own line.
There was a problem hiding this comment.
This is looking pretty 👌
A tad overkill for this repo but if others are okay with this style of README.md let's add it to the @shopify/javascript .
It helps makes our OSS presence a bit more polished.
README.md
Outdated
| A set of utilities for JavaScript and TypeScript projects at Shopify. | ||
| <h1 align="center"> | ||
| <br> | ||
| <a href="http://www.shopify.com/"><img src="https://cdn.shopify.com/assets2/press/brand/shopify-logo-main-small-f029fcaf14649a054509f6790ce2ce94d1f1c037b4015b4f106c5a67ab033f5b.png" alt="Shopify" width="200" /></a> |
There was a problem hiding this comment.
Really don’t like the big logo at the top, if we want to include it I think it should be below the license.
README.md
Outdated
| <br> | ||
| </h1> | ||
|
|
||
| <h4 align="center">A set of utilities for JavaScript and TypeScript projects at Shopify.</h4> |
There was a problem hiding this comment.
We can’t just toss a doc with styles to center around this whole thing?
README.md
Outdated
|
|
||
| <div align="center"> | ||
| <a href="https://shopify.com/"> | ||
| Website |
There was a problem hiding this comment.
Why are we linking to these things? This feels so counter to what I expect from an OSS project, we shouldn’t be hiding the “what is this and why is it good and how do I use it” behind a wall of branding IMO
README.md
Outdated
| Styleguide | ||
| </a> | ||
| <span> | </span> | ||
| <a href="http://github.com/Shopify/javascript-utilities/blob/master/CHANGELOG.md"> |
There was a problem hiding this comment.
This link is good but make it part of the TOC
|
@lemonmade, when you get back, can you take another look at this? |
|
I'm going to go ahead and merge this in, since all comments have been addressed. |
After discussions with the team, I decided I would try my hand at a "nice"
READMEfile that may be good to turn into a template in the future.Inspiration
Using an HTML header
I decided to go with an HTML header, because I noticed that the README files I liked in the
awesome-readmerepo all did this.Centred
I also liked the centred design better than a left-aligned version.
Note this is officially a markdown anti-pattern (as is any formatting); however, I don't think that's a big deal for GFM, since it's not "official" markdown. Also, seeing as how many READMEs are using this pattern (at least for the header), I don't see a problem with it.