From 4ca9d88b89ca4aa60185e2c4ed1d87ac03b67816 Mon Sep 17 00:00:00 2001 From: Jean-Denis VIDOT Date: Fri, 9 Aug 2024 13:08:10 +0200 Subject: [PATCH] :memo: docs(readme): add scripts --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index e5b6152..0d80b7c 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,18 @@ Make sure you have Node.js and Bun installed on your machine before running the bun install ``` +### Scripts + +- `bun run build`: Build the project. +- `bun run test`: Run the tests. +- `bun run test:watch`: Run the tests in watch mode. +- `bun run test:coverage`: Run the tests with coverage. +- `bun run test:coverage:watch`: Run the tests with coverage in watch mode. +- `bun run lint`: Lint the code and fix linting errors. +- `bun run lint:check`: Check the code for linting errors. +- `bun run format`: Format the code and fix formatting errors. +- `bun run format:check`: Check the code for formatting errors. + ### Project Structure ```plaintext