Skip to content

Commit

Permalink
doc: improve README.md usability
Browse files Browse the repository at this point in the history
* 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: #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>
  • Loading branch information
Trott authored and bengl committed Mar 21, 2022
1 parent 26d4a2d commit db83c4d
Showing 1 changed file with 2 additions and 10 deletions.
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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)
Expand Down

0 comments on commit db83c4d

Please sign in to comment.