Skip to content

docs: improve discoverability metadata #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CoderDeltaLAN merged 1 commit into from
Jun 9, 2026
Merged

docs: improve discoverability metadata #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ This project has no stable public release yet.

### Changed

- Improved README and project metadata for clearer GitHub and Python package discoverability.
- Added project URLs and more specific package keywords.
- Updated README status after publishing `v0.1.0` as a GitHub pre-release.
- Added basic installation guidance for release artifacts.

Expand Down
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<h1 align="center">agent-rules-kit</h1>

<p align="center">
<strong>Local Python CLI for diagnosing baseline quality of AI agent instruction files in repositories.</strong>
<strong>Local read-only Python CLI for diagnosing AGENTS.md, CLAUDE.md, GEMINI.md, Cursor rules, GitHub Copilot instructions, and other AI agent instruction files in repositories.</strong>
</p>

<p align="center">
Expand Down Expand Up @@ -86,7 +86,9 @@

## Overview

`agent-rules-kit` is a local diagnostic CLI for repositories that use AI coding agents or assistant-specific instruction files.
`agent-rules-kit` is a local, read-only diagnostic CLI for repositories that use AI coding agents or assistant-specific instruction files.

It helps developers inspect `AGENTS.md`, `CLAUDE.md`, `GEMINI.md`, Cursor rules, GitHub Copilot instructions, and GitHub instruction files without network calls, LLM calls, or repository command execution.

It focuses on files such as:

Expand Down
11 changes: 9 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ build-backend = "hatchling.build"
[project]
name = "agent-rules-kit"
version = "0.1.0"
description = "Local CLI to diagnose baseline quality of AI agent instruction files in repositories."
description = "Local read-only CLI to diagnose AGENTS.md, Claude Code, Gemini CLI, Cursor and Copilot instruction files."
readme = "README.md"
requires-python = ">=3.12"
license = { text = "MIT" }
authors = [{ name = "CoderDeltaLAN" }]
keywords = ["agents", "cli", "lint", "ai", "repository"]
keywords = ["ai-agents", "agent-instructions", "agents-md", "cli", "developer-tools", "python", "linting", "code-quality", "repository-diagnostics", "github-copilot", "cursor", "claude-code", "gemini-cli", "read-only", "local-first"]
classifiers = [
"Development Status :: 3 - Alpha",
"Environment :: Console",
Expand All @@ -22,6 +22,13 @@ classifiers = [
]
dependencies = []

[project.urls]
Repository = "https://github.com/CoderDeltaLAN/agent-rules-kit"
Issues = "https://github.com/CoderDeltaLAN/agent-rules-kit/issues"
Changelog = "https://github.com/CoderDeltaLAN/agent-rules-kit/blob/main/CHANGELOG.md"
Security = "https://github.com/CoderDeltaLAN/agent-rules-kit/security/policy"
Release = "https://github.com/CoderDeltaLAN/agent-rules-kit/releases/tag/v0.1.0"

[project.scripts]
agent-rules-kit = "agent_rules_kit.cli:main"

Expand Down
Loading