Documentation

commit-id:e51ac6f7
software-mansion · Dec 4, 2024 · f50a9dc · f50a9dc
1 parent 9fcabb6
commit f50a9dc
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+#### Added
+
+- `.cairo-coverage-ignore` file to exclude files or directories from the coverage report
+
 ## [0.3.0-rc0] - 2024-11-21
 
 #### Fixed

diff --git a/README.md b/README.md
@@ -35,6 +35,12 @@ curl -L https://raw.githubusercontent.com/software-mansion/cairo-coverage/main/s
 
 ## Usage
 
+### `.cairo-coverage-ignore` File
+
+You can create a `.cairo-coverage-ignore` file in the root of your project to specify the files or directories that you
+want to exclude from the coverage report. The file should contain a list of paths to be ignored, with one path per line,
+similar to a `.gitignore` file.
+
 ### Generate Coverage Report
 
 To generate a coverage report, run the `cairo-coverage` command with one or more `<PATH_TO_TRACE_DATA>` arguments. These