Skip to content

Commit 052b690

Browse files
committed
Update README.md and config file
1 parent 468b807 commit 052b690

4 files changed

Lines changed: 40 additions & 4 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 ForteScarlet
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
> KKP: **K**otlin Claude Code s**K**ill **P**lugin.
44
5+
[TOC]
6+
57
## Overview
68

79
Codex KKP is a Claude Code Plugin that enables seamless integration with Codex AI Agent for code
@@ -16,6 +18,11 @@ analysis, implementation, and collaboration tasks. Provides a subagent and a ski
1618
- **Claude Code Subagents**: Run subagents in parallel to improve performance
1719
- **Sugar-Free, Calorie-Free**: Very healthy
1820

21+
## Usage
22+
23+
After installation and configuration, you can use the Codex KKP plugin within Claude Code. The plugin provides
24+
a subagent and a skill for code analysis, implementation, and collaboration tasks.
25+
1926
## Installation
2027

2128
### Download from repository
@@ -50,10 +57,10 @@ Use `/plugin`:
5057
/plugin
5158
```
5259

53-
Choose `Add aarketplace`:
60+
Choose `Add marketplace`:
5461

5562
```
56-
> Add aarketplace
63+
> Add marketplace
5764
```
5865

5966
and enter the local path where you downloaded/cloned the repository.
@@ -135,4 +142,8 @@ and add the following configuration to property `permissions.allow`:
135142

136143
In `Bash`, the path refers to the executable file within the installed plugin package
137144
that corresponds to your system platform.
138-
You may need to make slight adjustments based on the actual situation.
145+
You may need to make slight adjustments based on the actual situation.
146+
147+
## License
148+
149+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

build.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ plugins {
55
}
66

77
group = "love.forte.tools"
8-
version = "0.0.5"
8+
version = "0.0.6"
99

1010
allprojects {
1111
repositories {

buildSrc/src/main/kotlin/PluginJson.kt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ fun pluginJson(
3030
"name": "$name",
3131
"version": "$version",
3232
"description": "$description",
33+
"license": "MIT",
34+
"homepage": "https://github.com/ForteScarlet/codex-kkp",
35+
"repository": "https://github.com/ForteScarlet/codex-kkp",
36+
"keywords": ["AI", "agent", "codex", "assistant"],
3337
"author": {
3438
"name": "$authorName",
3539
"email": "$authorEmail"

0 commit comments

Comments
 (0)