Skip to content

Commit

Permalink
doc: add more documentation to the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aignas committed Oct 26, 2023
1 parent f8c63b5 commit 8a1f463
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Shellcheck rules for bazel

Now you do not need to depend on the system shellcheck version in your bazel-managed (mono)repos.
Now you do not need to depend on the system `shellcheck` version in your bazel-managed (mono)repos.

[![Build Status](https://github.com/aignas/rules_shellcheck/workflows/CI/badge.svg)](https://github.com/aignas/rules_shellcheck/actions)

Expand All @@ -25,3 +25,7 @@ shellcheck_test(
severity = "warning",
)
```

Note: this is a simple project that allows me to learn about various bazel concepts. Feel free to create PRs contributing to the project or consider using [rules_lint].

[rules_lint]: https://github.com/aspect-build/rules_lint

0 comments on commit 8a1f463

Please sign in to comment.