kaide 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -16
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,6 +4,25 @@
|
|
|
4
4
|
|
|
5
5
|
> **Kaide** (Etymology: Turkish): A fundamental rule, principle, or base that provides structural integrity. The name cleverly embeds **AI** (K**ai**de), reflecting its core mission.
|
|
6
6
|
|
|
7
|
+
## Getting Started
|
|
8
|
+
|
|
9
|
+
### Installation & Setup
|
|
10
|
+
|
|
11
|
+
1. Run the CLI to automatically install the configuration files:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx kaide
|
|
15
|
+
```
|
|
16
|
+
2. (Recommended) For maximum adherence, point your AI tool to your identity in **Settings/Project Rules**:
|
|
17
|
+
|
|
18
|
+
> **Adhere to `AGENTS.md` for persona/planning and `docs/` for architectural constitutions.**
|
|
19
|
+
|
|
20
|
+
### Usage Workflow
|
|
21
|
+
This kit follows a **Plan-First Protocol**:
|
|
22
|
+
- **Initialize:** Ask the AI to read the rules: `Read all .mdc files and AGENTS.md.`
|
|
23
|
+
- **Plan:** Propose a feature: `I want to build a [Feature Name]. Create an architectural plan.`
|
|
24
|
+
- **Execute:** After approving the plan, the AI will generate code following the strict constraints of the relevant `.mdc` files.
|
|
25
|
+
|
|
7
26
|
## The Problem We Solve
|
|
8
27
|
|
|
9
28
|
**Kaide** provides the missing governance layer to turn AI from a simple coder into a high-level Staff Engineer.
|
|
@@ -28,21 +47,6 @@ The system operates on a **Three-Layer Governance** model:
|
|
|
28
47
|
- **Optimized for Modern Tech:** Seamless support for Next.js and TanStack Start for world-class web applications.
|
|
29
48
|
- **Performance-First:** Built-in rules for LCP optimization, CLS prevention, and maximum efficiency.
|
|
30
49
|
|
|
31
|
-
## Getting Started
|
|
32
|
-
|
|
33
|
-
### Installation & Setup
|
|
34
|
-
|
|
35
|
-
1. Copy the `.cursor/rules/` folder, `docs/` directory, and `AGENTS.md` file to your project root.
|
|
36
|
-
2. (Recommended) For maximum adherence, point your AI tool to your identity in **Settings/Project Rules**:
|
|
37
|
-
|
|
38
|
-
> **Adhere to `AGENTS.md` for persona/planning and `docs/` for architectural constitutions.**
|
|
39
|
-
|
|
40
|
-
### Usage Workflow
|
|
41
|
-
This kit follows a **Plan-First Protocol**:
|
|
42
|
-
- **Initialize:** Ask the AI to read the rules: `Read all .mdc files and AGENTS.md.`
|
|
43
|
-
- **Plan:** Propose a feature: `I want to build a [Feature Name]. Create an architectural plan.`
|
|
44
|
-
- **Execute:** After approving the plan, the AI will generate code following the strict constraints of the relevant `.mdc` files.
|
|
45
|
-
|
|
46
50
|
## LLM Agnostic Usage
|
|
47
51
|
While optimized for Cursor (`.mdc`), **Kaide** is built on pure Markdown and works with any "Agentic" AI (Claude Code, Windsurf, GitHub Copilot CLI, etc.):
|
|
48
52
|
- All `.mdc` files are standard Markdown. No conversion is needed.
|
|
@@ -60,4 +64,4 @@ While optimized for Cursor (`.mdc`), **Kaide** is built on pure Markdown and wor
|
|
|
60
64
|
## Security & Performance
|
|
61
65
|
- **Zero Inline Script:** Strictly enforced CSP compliance.
|
|
62
66
|
- **Locked Boundaries:** Server-only logic is isolated from client bundles.
|
|
63
|
-
- **Optimized Assets:** Automatic enforcement of modern formats and performance patterns for peak scores.
|
|
67
|
+
- **Optimized Assets:** Automatic enforcement of modern formats and performance patterns for peak scores.
|