From 400cff3b62e7cabe0c3088fb3e94cd899ffd3a4b Mon Sep 17 00:00:00 2001 From: Victorien Elvinger Date: Mon, 27 Nov 2023 15:09:48 +0100 Subject: [PATCH] docs(README): make more epxlicit the benefits of Biome --- packages/@biomejs/biome/README.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/packages/@biomejs/biome/README.md b/packages/@biomejs/biome/README.md index d740aabdb487..83079b7fd75f 100644 --- a/packages/@biomejs/biome/README.md +++ b/packages/@biomejs/biome/README.md @@ -26,7 +26,15 @@ -**Biome** is a toolchain for web projects, it aims to provide developer tools to maintain the health of said projects. +**Biome** is a performant toolchain for web projects, it aims to provide developer tools to maintain the health of said projects. + +**Biome is a [fast formatter](./benchmark#formatting)** for _JavaScript_, _TypeScript_, _JSX_, and _JSON_ that scores **[96% compatibility with _Prettier_](https://console.algora.io/challenges/prettier)**. + +**Biome is a [performant linter](https://github.com/biomejs/biome/tree/main/benchmark#linting)** for _JavaScript_, _TypeScript_, and _JSX_ that features **[more than 170 rules](https://biomejs.dev/linter/rules/)** from ESLint, TypeSCript ESLint, and [other sources](https://github.com/biomejs/biome/discussions/3). +It **outputs detailed and contextualized diagnostics** that help you to improve your code and become a better programmer! + +**Biome** is designed from the start to be used [interactively within an editor](https://biomejs.dev/guides/integrate-in-editor/). +It can format and lint malformed code as you are writing it. ### Installation @@ -57,24 +65,21 @@ If you want to give Biome a run without installing it, use the [online playgroun Check out our [homepage][biomejs] to learn more about Biome, or directly head to the [Getting Started guide][getting-started] to start using Biome. -## About Biome +## More about Biome -**Biome** formats and lints your code in a [fraction of a second][bench]. +**Biome** has sane defaults and it doesn't require configuration. + +**Biome** aims to support [all main languages][language-support] of modern web development. **Biome** [doesn't require Node.js](https://biomejs.dev/guides/manual-installation/) to function. **Biome** has first-class LSP support, with a sophisticated parser that represents the source text in full fidelity and top-notch error recovery. -**Biome** supports JavaScript, TypeScript, JSON, and more. It aims to support [all main languages][language-support] of modern web development. - -**Biome** has sane defaults and it doesn't require configuration. - -**Biome** helps you as much as possible by displaying detailed and contextualized diagnostics. Read more about our [project philosophy][biome-philosophy]. - **Biome** unifies functionality that has previously been separate tools. Building upon a shared base allows us to provide a cohesive experience for processing code, displaying errors, parallelize work, caching, and configuration. -**Biome** is [MIT licensed](https://github.com/biomejs/biome/tree/main/LICENSE-MIT) or [Apache 2.0 licensed](https://github.com/biomejs/biome/tree/main/LICENSE-APACHE) and moderated under the [Contributor Covenant Code of Conduct](https://github.com/biomejs/biome/tree/main/CODE_OF_CONDUCT.md). +Read more about our [project philosophy][biome-philosophy]. +**Biome** is [MIT licensed](https://github.com/biomejs/biome/tree/main/LICENSE-MIT) or [Apache 2.0 licensed](https://github.com/biomejs/biome/tree/main/LICENSE-APACHE) and moderated under the [Contributor Covenant Code of Conduct](https://github.com/biomejs/biome/tree/main/CODE_OF_CONDUCT.md). ## Sponsors