Skip to content

Commit

Permalink
docs: update README to improve clarity and add CI badge
Browse files Browse the repository at this point in the history
  • Loading branch information
ErwannRousseau committed Nov 26, 2024
1 parent cf1188d commit 52513a5
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Biome config
# Biome Config

A simple configuration utility for [Biome.js](https://biomejs.dev/), the best linter/formatter for JavaScript.

![CI](https://github.com/erwannrousseau/biome-config/workflows/CI/badge.svg)

## Usage

### For new projects
Expand All @@ -17,7 +19,7 @@ This command will:
- Install `@biomejs/biome`.
- Create a `biome.json` file in your project root with a complete configuration ready to work.

You'll also be prompted to add custom scripts to your `package.json` file, which will help you run `biome.js` commands more easily.
You will be prompted to add custom scripts to your `package.json` file to run `biome.js` commands more easily.

### For updating your configuration

Expand All @@ -32,7 +34,7 @@ This command will:
- Update the latest version of `@biomejs/biome`.
- Update your `biome.json` file with the latest `$schema` version.

## What's next?
## What's Next?

To use `biome.js` as your default linter and formatter, you should install the following VS Code extension:

Expand Down

0 comments on commit 52513a5

Please sign in to comment.