Skip to content

Commit 67a91b8

Browse files
TMHSDigitalTMHSDigital
committed
fix: match README style to other repos -- centered header, badges, dropdowns, tables
Made-with: Cursor
1 parent 7383d18 commit 67a91b8

File tree

1 file changed

+108
-39
lines changed

1 file changed

+108
-39
lines changed

‎README.md‎

Lines changed: 108 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,110 @@
1-
# Developer Tools Directory
1+
<div align="center">
2+
<img src="assets/logo.png" alt="Developer Tools Directory" width="120" />
3+
</div>
24

3-
**Centralized catalog, standards, and scaffolding for TMHSDigital Cursor IDE plugins, MCP servers, and developer tools.**
5+
<h1 align="center">Developer Tools Directory</h1>
46

5-
![License: CC BY-NC-ND 4.0](https://img.shields.io/badge/license-CC--BY--NC--ND--4.0-green)
7+
<p align="center">
8+
<strong>Centralized catalog, standards, and scaffolding for TMHSDigital Cursor IDE plugins, MCP servers, and developer tools.</strong>
9+
</p>
10+
11+
<p align="center">
12+
<a href="https://tmhsdigital.github.io/Developer-Tools-Directory/"><img src="https://img.shields.io/badge/catalog-live-7c3aed" alt="Catalog" /></a>
13+
<img src="https://img.shields.io/badge/license-CC--BY--NC--ND--4.0-green" alt="License: CC BY-NC-ND 4.0" />
14+
<a href="https://github.com/TMHSDigital/Developer-Tools-Directory/stargazers"><img src="https://img.shields.io/github/stars/TMHSDigital/Developer-Tools-Directory?style=flat" alt="GitHub stars" /></a>
15+
</p>
16+
17+
<p align="center">
18+
<a href="#tools">Tools</a> &bull;
19+
<a href="#standards">Standards</a> &bull;
20+
<a href="#scaffold-generator">Scaffold</a> &bull;
21+
<a href="https://tmhsdigital.github.io/Developer-Tools-Directory/">Catalog Site</a>
22+
</p>
623

724
---
825

9-
> 9 repos -- 186 skills -- 77 rules -- 377 MCP tools
26+
<p align="center">
27+
9 repos &nbsp;&bull;&nbsp; 186 skills &nbsp;&bull;&nbsp; 77 rules &nbsp;&bull;&nbsp; 377 MCP tools
28+
</p>
29+
30+
## How It Works
31+
32+
```mermaid
33+
flowchart LR
34+
A["registry.json\n(source of truth)"] --> B["GitHub Pages\ncatalog site"]
35+
A --> C["README tables\n(below)"]
36+
D["scaffold/\ncreate-tool.py"] --> E["New repo with\nall standards"]
37+
F["standards/\n(conventions)"] --> D
38+
```
39+
40+
**Registry** tracks every tool repo. **Standards** document conventions for CI/CD, folder structure, manifests, and versioning. **Scaffold** generates new repos that follow those standards automatically.
1041

1142
## Tools
1243

13-
| Tool | Type | Skills | Rules | MCP Tools | Links |
14-
| --- | --- | ---: | ---: | ---: | --- |
15-
| **CFX Developer Tools** | Plugin | 9 | 6 | 6 | [Repo](https://github.com/TMHSDigital/CFX-Developer-Tools) - [Docs](https://tmhsdigital.github.io/CFX-Developer-Tools/) |
44+
| Tool | Type | Skills | Rules | MCP&nbsp;Tools | Links |
45+
|:-----|:-----|-------:|------:|------:|:------|
46+
| **CFX Developer Tools** | Plugin | 9 | 6 | 6 | [Repo](https://github.com/TMHSDigital/CFX-Developer-Tools) &bull; [Docs](https://tmhsdigital.github.io/CFX-Developer-Tools/) |
1647
| **Unity Developer Tools** | Plugin | 18 | 8 | 4 | [Repo](https://github.com/TMHSDigital/Unity-Developer-Tools) |
17-
| **Docker Developer Tools** | Plugin | 17 | 10 | 150 | [Repo](https://github.com/TMHSDigital/Docker-Developer-Tools) - [Docs](https://tmhsdigital.github.io/Docker-Developer-Tools/) |
18-
| **Home Lab Developer Tools** | Plugin | 22 | 11 | 50 | [Repo](https://github.com/TMHSDigital/Home-Lab-Developer-Tools) - [Docs](https://tmhsdigital.github.io/Home-Lab-Developer-Tools/) |
48+
| **Docker Developer Tools** | Plugin | 17 | 10 | 150 | [Repo](https://github.com/TMHSDigital/Docker-Developer-Tools) &bull; [Docs](https://tmhsdigital.github.io/Docker-Developer-Tools/) |
49+
| **Home Lab Developer Tools** | Plugin | 22 | 11 | 50 | [Repo](https://github.com/TMHSDigital/Home-Lab-Developer-Tools) &bull; [Docs](https://tmhsdigital.github.io/Home-Lab-Developer-Tools/) |
1950
| **Mobile App Developer Tools** | Plugin | 43 | 12 | 36 | [Repo](https://github.com/TMHSDigital/Mobile-App-Developer-Tools) |
2051
| **Plaid Developer Tools** | Plugin | 17 | 7 | 30 | [Repo](https://github.com/TMHSDigital/Plaid-Developer-Tools) |
21-
| **Monday Cursor Plugin** | Plugin | 21 | 8 | 45 | [Repo](https://github.com/TMHSDigital/Monday-Cursor-Plugin) - [Docs](https://tmhsdigital.github.io/Monday-Cursor-Plugin/) |
22-
| **Steam Cursor Plugin** | Plugin | 30 | 9 | 25 | [Repo](https://github.com/TMHSDigital/Steam-Cursor-Plugin) - [Docs](https://tmhsdigital.github.io/Steam-Cursor-Plugin/) |
23-
| **Steam MCP Server** | MCP Server | 0 | 0 | 25 | [Repo](https://github.com/TMHSDigital/steam-mcp) - [npm](https://www.npmjs.com/package/@tmhs/steam-mcp) |
52+
| **Monday Cursor Plugin** | Plugin | 21 | 8 | 45 | [Repo](https://github.com/TMHSDigital/Monday-Cursor-Plugin) &bull; [Docs](https://tmhsdigital.github.io/Monday-Cursor-Plugin/) |
53+
| **Steam Cursor Plugin** | Plugin | 30 | 9 | 25 | [Repo](https://github.com/TMHSDigital/Steam-Cursor-Plugin) &bull; [Docs](https://tmhsdigital.github.io/Steam-Cursor-Plugin/) |
54+
| **Steam MCP Server** | MCP Server | -- | -- | 25 | [Repo](https://github.com/TMHSDigital/steam-mcp) &bull; [npm](https://www.npmjs.com/package/@tmhs/steam-mcp) |
55+
56+
<details>
57+
<summary>Tool descriptions</summary>
58+
59+
&nbsp;
60+
61+
| Tool | Description |
62+
|:-----|:------------|
63+
| **CFX Developer Tools** | AI-powered Cursor IDE plugin for FiveM and RedM resource development. Scaffold resources, look up 12,000+ natives, generate manifests, and write optimized scripts in Lua, JavaScript, and C#. |
64+
| **Unity Developer Tools** | Cursor plugin for Unity game development with URP, HDRP, and Built-in render pipeline support. 20 snippets and 5 starter templates. |
65+
| **Docker Developer Tools** | Expert Docker workflows for Cursor, Claude Code, and any MCP-compatible editor. Container management, Compose, and Dockerfile best practices. |
66+
| **Home Lab Developer Tools** | Home lab and Raspberry Pi workflows with Docker Compose, monitoring, DNS, networking, backups, security, and administration via SSH. |
67+
| **Mobile App Developer Tools** | Full mobile development lifecycle for React Native, Expo, and Flutter -- from project setup to app store submission. |
68+
| **Plaid Developer Tools** | Cursor plugin and MCP companion for building on the Plaid API. Banking, fintech, and open-banking integrations. |
69+
| **Monday Cursor Plugin** | Monday.com integration with boards, items, sprints, docs, dashboards, and GraphQL queries. |
70+
| **Steam Cursor Plugin** | Steam and Steamworks integration for game developers, modders, and power users. Store data, achievements, Workshop, multiplayer, and cloud saves. |
71+
| **Steam MCP Server** | Standalone MCP server for Steam and Steamworks APIs. 18 read-only + 7 write tools. Published on npm as `@tmhs/steam-mcp`. |
72+
73+
</details>
2474

2575
## Standards
2676

27-
Documented conventions for building new developer tools. See the full standards in [`standards/`](standards/).
77+
Documented conventions for building new developer tools. All docs in [`standards/`](standards/).
2878

2979
| Standard | Summary |
30-
| --- | --- |
80+
|:---------|:--------|
3181
| [Folder Structure](standards/folder-structure.md) | Canonical repo layout for plugins and MCP servers |
32-
| [Plugin Manifest](standards/plugin-manifest.md) | `.cursor-plugin/plugin.json` specification |
33-
| [CI/CD](standards/ci-cd.md) | GitHub Actions workflows every repo must have |
34-
| [GitHub Pages](standards/github-pages.md) | Documentation site setup (static HTML or MkDocs) |
82+
| [Plugin Manifest](standards/plugin-manifest.md) | `.cursor-plugin/plugin.json` specification and required fields |
83+
| [CI/CD](standards/ci-cd.md) | GitHub Actions workflows every repo must have (validate, release, pages, stale) |
84+
| [GitHub Pages](standards/github-pages.md) | Documentation site setup -- static HTML or MkDocs Material |
3585
| [Commit Conventions](standards/commit-conventions.md) | Conventional commits and version bumping rules |
36-
| [README Template](standards/readme-template.md) | Standard README structure |
86+
| [README Template](standards/readme-template.md) | Standard README structure and required sections |
3787
| [AGENTS.md Template](standards/agents-template.md) | AI agent guidance file structure |
38-
| [Versioning](standards/versioning.md) | Semver management and release flow |
88+
| [Versioning](standards/versioning.md) | Semver management and automated release flow |
3989

40-
## Scaffold Generator
90+
<details>
91+
<summary>Core principles</summary>
4192

42-
Generate a fully standards-compliant repository from the command line.
93+
&nbsp;
4394

44-
### Prerequisites
95+
1. **Automation first** -- CI handles versioning, releases, badge updates, and repo metadata. Manual edits to managed fields will be overwritten.
96+
2. **Single branch** -- All repos use `main` only. No develop, staging, or release branches.
97+
3. **Conventional commits** -- Every commit follows the conventional format. The release workflow parses them to determine version bumps.
98+
4. **AI-agent friendly** -- Every repo includes `AGENTS.md` and `.cursorrules` so AI coding agents understand the project.
99+
5. **Public by default** -- Standards, docs, and tooling are written for public consumption.
45100

46-
```bash
47-
pip install Jinja2
48-
```
101+
</details>
102+
103+
## Scaffold Generator
104+
105+
Generate a fully standards-compliant repository from the command line.
49106

50-
### Usage
107+
**Prerequisites:** `pip install Jinja2`
51108

52109
```bash
53110
python scaffold/create-tool.py \
@@ -58,10 +115,13 @@ python scaffold/create-tool.py \
58115
--rules 3
59116
```
60117

61-
### Options
118+
<details>
119+
<summary>All options</summary>
120+
121+
&nbsp;
62122

63123
| Flag | Required | Default | Description |
64-
| --- | --- | --- | --- |
124+
|:-----|:---------|:--------|:------------|
65125
| `--name` | Yes | -- | Display name (e.g., "Unreal Developer Tools") |
66126
| `--description` | Yes | -- | One-line description |
67127
| `--slug` | No | auto | Kebab-case identifier (derived from name) |
@@ -74,36 +134,45 @@ python scaffold/create-tool.py \
74134
| `--author-name` | No | TMHSDigital | Author name for manifests |
75135
| `--author-email` | No | contact@... | Author email |
76136

77-
### What It Generates
137+
</details>
138+
139+
<details>
140+
<summary>What it generates</summary>
141+
142+
&nbsp;
78143

79144
- Full folder structure per the [standard](standards/folder-structure.md)
80145
- Populated `plugin.json` with provided metadata
81146
- All 4 core GitHub Actions workflows (validate, release, pages, stale)
82147
- Skeleton docs: `AGENTS.md`, `CLAUDE.md`, `README.md`, `CONTRIBUTING.md`, `CHANGELOG.md`, `CODE_OF_CONDUCT.md`, `SECURITY.md`, `ROADMAP.md`
83148
- GitHub Pages site template (`docs/index.html`)
84-
- MCP server scaffold (if `--mcp-server` flag)
149+
- MCP server scaffold (if `--mcp-server`): `server.py`, `tools/`, `data/`, `requirements.txt`
85150
- `.cursorrules`, `.gitignore`, `LICENSE`
86151

87-
## Catalog Site
88-
89-
Browse all tools visually at the [GitHub Pages catalog](https://tmhsdigital.github.io/Developer-Tools-Directory/).
152+
</details>
90153

91154
## Project Structure
92155

93156
```
94157
Developer-Tools-Directory/
95-
.github/workflows/ CI/CD for this repo (validate, pages)
158+
.github/workflows/ CI/CD (validate, pages)
159+
assets/ Logo
96160
docs/ GitHub Pages catalog site
97-
scaffold/ Repo generator script + Jinja2 templates
98-
standards/ Convention documentation
161+
scaffold/ Repo generator + Jinja2 templates
162+
standards/ Convention documentation (9 docs)
99163
registry.json Tool registry (source of truth)
100-
README.md
101164
```
102165

166+
## Contributing
167+
168+
Pull requests welcome. See the [standards](standards/) for conventions.
169+
103170
## License
104171

105-
CC-BY-NC-ND-4.0 -- see [LICENSE](LICENSE) for details.
172+
CC BY-NC-ND 4.0 -- see [LICENSE](LICENSE) for details.
106173

107174
---
108175

109-
**Built by [TMHSDigital](https://github.com/TMHSDigital)**
176+
<p align="center">
177+
<strong>Built by <a href="https://github.com/TMHSDigital">TMHSDigital</a></strong>
178+
</p>

0 commit comments

Comments
 (0)