Skip to content

Commit f2a96d2

Browse files
committed
feat: Improve README formatting and add icons
1 parent 092d622 commit f2a96d2

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

linters/typescript/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Codebase Context Lint
1+
# 🧠💻 Codebase Context Lint
22

33
<div align="center">
4-
<img src="https://raw.githubusercontent.com/Agentic-Insights/codebase-context-spec/main/img/codebase-context.png" alt="Codebase Context Lint Logo" width="200" height="200">
4+
<img src="https://raw.githubusercontent.com/Agentic-Insights/codebase-context-spec/main/img/codebase-context.png" alt="Codebase Context Lint Logo" width="500">
55
</div>
66

77
<h3 align="center">Codebase Context Lint</h3>
@@ -17,19 +17,19 @@
1717
<a href="https://github.com/Agentic-Insights/codebase-context-spec/issues/new?template=feature_request.md">Request feature</a>
1818
</p>
1919

20-
## Overview
20+
## 🔎 Overview
2121

2222
This is a CLI linter for validating AI Context Convention files, including `.context.md`, `.context.yaml`, `.context.json`, `.contextdocs.md`, and `.contextignore` files.
2323

24-
## Installation
24+
## 📦 Installation
2525

2626
You can install the linter globally using npm:
2727

2828
```
2929
npm install -g codebase-context-lint
3030
```
3131

32-
## Usage
32+
## 🚀 Usage
3333

3434
After installation, you can use the linter from the command line:
3535

@@ -39,15 +39,15 @@ ai-context-lint <directory_to_lint>
3939

4040
Replace `<directory_to_lint>` with the path to the directory containing your AI Context Convention files.
4141

42-
## Features
42+
## Features
4343

44-
- Validates the structure and content of `.context.md`, `.context.yaml`, and `.context.json` files
45-
- Checks for required fields and sections
46-
- Verifies the format of `.contextdocs.md` files
47-
- Validates ignore patterns in `.contextignore` files
48-
- Provides detailed error messages and warnings
44+
- 🔍 Validates the structure and content of `.context.md`, `.context.yaml`, and `.context.json` files
45+
- Checks for required fields and sections
46+
- 📄 Verifies the format of `.contextdocs.md` files
47+
- 🚫 Validates ignore patterns in `.contextignore` files
48+
- 💬 Provides detailed error messages and warnings
4949

50-
## Development
50+
## 🛠️ Development
5151

5252
To contribute to this project:
5353

@@ -78,6 +78,6 @@ To contribute to this project:
7878
7. Push to the branch (`git push origin feature/AmazingFeature`)
7979
8. Open a Pull Request
8080

81-
## License
81+
## 📄 License
8282

8383
This project is licensed under the MIT License.

0 commit comments

Comments
 (0)