Skip to content

Commit ff4a735

Browse files
committed
Update README.md
1 parent 0c24290 commit ff4a735

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

.github/workflows/build-docs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ on: [push, workflow_dispatch]
44

55
jobs:
66
build:
7+
permissions:
8+
contents: write
79
runs-on: ubuntu-latest
810
steps:
911
- uses: actions/checkout@v4

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,18 @@
22

33
A Python and Rust package for linting C/C++ code with clang-tidy and/or clang-format to collect feedback provided in the form of thread comments, step summary, or file annotations.
44

5+
> [!CAUTION]
6+
> [![codecov](https://codecov.io/gh/cpp-linter/cpp_linter_rs/graph/badge.svg?token=7ibzERx2AD)](https://codecov.io/gh/cpp-linter/cpp_linter_rs)
7+
>
8+
> This project is still experimental and subject to drastic changes.
9+
> Please use the pure python [cpp-linter](https://github.com/cpp-linter/cpp-linter)
10+
> package until this project is ready for deployment.
11+
512
## Usage
613

714
For usage in a CI workflow, see [the cpp-linter/cpp-linter-action repository](https://github.com/cpp-linter/cpp-linter-action).
815

9-
For the description of supported Command Line Interface options, see [the CLI documentation](https://cpp-linter.github.io/cpp-linter/cli_args.html).
16+
For the description of supported Command Line Interface options, see [the CLI documentation](https://cpp-linter.github.io/cpp_linter_rs/cli_args.html).
1017

1118
## Have question or feedback?
1219

0 commit comments

Comments
 (0)