From 8a1f463a410fec7a470fa02863d07a682baa5f0b Mon Sep 17 00:00:00 2001
From: Ignas Anikevicius <240938+aignas@users.noreply.github.com>
Date: Thu, 26 Oct 2023 22:50:49 +0900
Subject: [PATCH] doc: add more documentation to the README.md

---
 README.md | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 853c2ae..5840c54 100644
--- a/README.md
+++ b/README.md
@@ -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)
 
@@ -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