Node: doc: intent to restructure README.md to be more advertising and introducing to docs

[eljefedelrodeodeljefe]

Our README.md currently is quite technical - in terms of being useful for collaboration and security-wise(?).

I am convinced efforts moving towards the READE being more advertising and attractive to the reader is worthwhile.

Good examples that come to mind:

• https://github.com/kubernetes/kubernetes
• https://github.com/docker/docker
• https://github.com/libuv/libuv for the upper part

This would mean moving GPG stuff, maybe also the collaborator list, adding a logo etc.

[claudiorodriguez]

+1, at the very least I suggest having an easily recognizable link to our docs in the readme's first fold

[eljefedelrodeodeljefe]

For starters I could imagine something like:

---

README.md

Node.js

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

[eljefedelrodeodeljefe]

cc @nodejs/documentation @nodejs/website

[preco21]

What about big simbol on top of README.md?

As like: https://github.com/avajs/ava

[ghost]

@preco21 yeah, that sounds like what @eljefedelrodeodeljefe suggested

[eljefedelrodeodeljefe]

@preco21 I guess you mean before the h1-tag. This is the above. "README.md" just indicated what file we are in.

[silverwind]

Where would those LTS and Docs buttons lead to? nevermind

By the way, If you're going with a logo, I'd say the h1 is redundant.

[ghost]

@silverwind does markdown do alt attributes? i'm worried about accessibility

[silverwind]

@tentakel yes, it does:

[![hi](http://res.cloudinary.com/jefe-io/image/upload/v1464098345/NodeJS_New_Pantone_owaqpk.png)](https://nodejs.org)    

GitHub also supports a (very limited) set of HTML, but depending on where it's rendered, it might not get parsed correctly because HTML is a feature of Github-flavored markdown, e.g. non-standard.

<a href="https://nodejs.org">
  <img alt="hi" src="http://res.cloudinary.com/jefe-io/image/upload/v1464098345/NodeJS_New_Pantone_owaqpk.png"></img>
</a>

[silverwind]

Oh, and if we go with a logo, I'd really like to see a SVG (does a vector source file it exist?).

[eljefedelrodeodeljefe]

@silverwind semantically I agree, I think though that the h1-tag gets to be honored in SEO really well (all structure tags tho.)

ACK svg

[eljefedelrodeodeljefe]

Is there anyone with good design skills? maybe @mikeal for hooking up design people.

[preco21]

@eljefedelrodeodeljefe I mean, h1-tag as graphical logo with link.

[claudiorodriguez]

There's this: https://commons.wikimedia.org/wiki/File:Node.js_logo.svg but the colors look a bit off

[kravelin]

Here's an SVG version of the logo, note I had to put it in a zip file as gitHub doesn't support uploading SVG files in the comments. I also tested using an svg image in a readme.md file and it didn't display on github, giving only the missing image icon so the svg may not be useful in this case and we'd have to use the png format.
logo-svg.zip

[lpinca]

An SVG version of the logo is also available here https://nodejs.org/static/images/logo.svg thanks to @silverwind (https://github.com/nodejs/nodejs.org/pull/884).

[silverwind]

SVG works in READMEs, the light version should be more suitable in this case. I guess I can start on a PR. Do we want a horizontally centered logo, btw?

(I don't see @kravelin's version suitable, it's just a bitmap embedded in a SVG while mine is a proper scalable image)

[silverwind]

Logo PR here: https://github.com/nodejs/node/pull/12148

[Trott]

This issue has been inactive for sufficiently long that it seems like perhaps it should be closed. Feel free to re-open (or leave a comment requesting that it be re-opened) if you disagree. (Or just make the changes to README and open a PR! :-D ) I'm just tidying up and not acting on a super-strong opinion or anything like that.