diff options
author | Rich Trott <rtrott@gmail.com> | 2022-03-19 08:35:20 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-03-19 15:35:20 +0000 |
commit | 7fdb9d553432faa89debdef603e814b9cd618eea (patch) | |
tree | 222cedd10c8bff0eff0247d4d3ebe2ebaa6e851b /README.md | |
parent | 46a0d0d4bf011bb747d20df9f2eae16171b06c68 (diff) | |
download | node-new-7fdb9d553432faa89debdef603e814b9cd618eea.tar.gz |
doc: improve README.md usability
* The logo takes a lot of room doesn't add information.
* Make Node.js a top-level header and Table of Contents a second-level
header.
This looks better, improve semantics, makes the README.md more usable in
its raw form, and aligns us with README.md practices in other projects
like TypeScript and Deno.
PR-URL: https://github.com/nodejs/node/pull/42378
Reviewed-By: Michaƫl Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 12 |
1 files changed, 2 insertions, 10 deletions
@@ -1,12 +1,4 @@ -<p align="center"> - <a href="https://nodejs.org/"> - <img - alt="Node.js" - src="https://nodejs.org/static/images/logo-light.svg" - width="400" - /> - </a> -</p> +# Node.js Node.js is an open-source, cross-platform, JavaScript runtime environment. @@ -17,7 +9,7 @@ The Node.js project uses an [open governance model](./GOVERNANCE.md). The **This project has a [Code of Conduct][].** -# Table of contents +## Table of contents * [Support](#support) * [Release types](#release-types) |