Skip to content

Commit

Permalink
doc: Add "Notes" section
Browse files Browse the repository at this point in the history
  • Loading branch information
kulla committed Apr 14, 2024
1 parent 9efeb0c commit 3c2c829
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,8 @@ This package contain helper scripts to show the coverage of GraphQL fields and t

- Use `yarn show-coverage` to show the coverage of GraphQL types and fields in the terminal.
- Use `yarn generate-report` to generate a report about the coverage in `public/index.html`.

## Notice

- In [`download_documents.ts`](./download_documents.ts) in the variable `repos` is defined which repositories are scanned for graphql queries.
- In [`download_documents`](./download_documents.ts) there are also the regexes stored which are used to detect GraphQL statements.

0 comments on commit 3c2c829

Please sign in to comment.