Skip to content

Commit f5a1236

Browse files
committed
add how to use .clj-kondo part to README
1 parent 240b3bf commit f5a1236

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -943,6 +943,14 @@ And get a bullet list which uses bear emojis for the bullets.
943943
Girouette provides. You can change that by adding a `^:replace` tag (this uses
944944
meta-merge). e.g. `{:colors ^:replace {...}}`)
945945

946+
## clj-kondo Support
947+
948+
This library includes a built-in clj-kondo configuration to improve linting for Ornament components.
949+
950+
To use the configuration, simply copy the .clj-kondo/ directory from this repository into the root of your project.
951+
952+
After copying the directory, clj-kondo will automatically use this configuration to provide more accurate linting and reduce false positives in your Ornament projects.
953+
946954
## Babashka compatibility
947955

948956
Unfortunately Ornament is not bb-compatible, and most likely never will be.

0 commit comments

Comments
 (0)