Expand README with Biome features and usage #863
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added detailed description of Biome's features, installation, and language support.
Added installation instructions for using Biome as a dependency and stand-alone.
nhedger
requested changes
Nov 18, 2025
Member
There was a problem hiding this comment.
I agree the README could do a better job introducing what Biome is, but repeating information already covered on our website just adds extra maintenance. Listing supported languages, their status, or installation options would need constant updates to stay accurate. The current description also doesn’t match what the project actually does. Biome isn’t a bundler, a minifier, or a testing framework. If you have a clearer or more accurate description in mind, I’d be happy to take a look.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added detailed description of Biome's features, installation, and language support.
Summary
The README is lacking important context for users who find BIOME through the VSCode marketplace. How is anyone supposed to know what BIOME is when you hide behind such abstract obfuscated words?
Description
Added the all-important definition of what BIOME is and does for the user. Your page is entirely missing any mention of its core functionality as a formatter and linter. This is important to users.
Added proper usage instructions that explain how to make the plugin do anything. Also told users when to use a per-project installation vs when to use a global installation (or...did I? I might have forgotten to include this).
Changed the "Installation" section to "Availability". It's more accurate.
Related Issue
biomejs/website#3490
Checklist