Skip to content

doc: improve README.md usability #42378

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nodejs-github-bot merged 1 commit into from
Mar 19, 2022
Merged

doc: improve README.md usability #42378

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
  • Loading branch information
@Trott
Trott committed Mar 17, 2022
commit 1c61ae27904e477852be71452d8ca75868156190
12 changes: 2 additions & 10 deletions README.md
View file
Open in desktop
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