Skip to content
This repository was archived by the owner on Aug 30, 2025. It is now read-only.

Commit c4ff3ed

Browse files
committed
feat: created README
1 parent ced8a5a commit c4ff3ed

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,29 @@
1-
# replace this
1+
# Biome component for Projen NodeJS projects
2+
3+
- [Biome](https://biomejs.dev/)
4+
- [Projen](https://projen.io)
5+
6+
## Example usage
7+
8+
- in Projen configuration file (usually `.projenrc.ts` or `.projenrc.js`) import `Biome` component and create new instance of it:
9+
10+
```ts
11+
import { cdk } from 'projen'
12+
import { Biome } from "projen-biome";
13+
14+
const project = new cdk.JsiiProject({
15+
defaultReleaseBranch: "main",
16+
devDeps: ["projen-biome"],
17+
eslint: false,
18+
prettier: false,
19+
name: "biome-example",
20+
projenrcTs: true,
21+
});
22+
23+
new Biome(project);
24+
25+
project.synth();
26+
```
27+
28+
- Run only linting with `npm run biome`
29+
- Run full testing (including tests and linting/formatting) with `npm run test`

0 commit comments

Comments
 (0)