diff options
author | Rich Trott <rtrott@gmail.com> | 2022-03-19 18:35:20 +0300 |
---|---|---|
committer | Danielle Adams <adamzdanielle@gmail.com> | 2022-04-24 05:47:22 +0300 |
commit | 208ab5723efd0b08b945746a277d3269a5c78f27 (patch) | |
tree | b736c8e99303b4eedc433d1f8b19b6d7996cca37 /README.md | |
parent | ad17c9ce0cab2ff619e2c50e53da90bb35dbc998 (diff) |
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
diff --git a/README.md b/README.md index 3965fc2e18a..e305d58c4ee 100644 --- a/README.md +++ b/README.md @@ -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) |