Procházet zdrojové kódy

Fix installation instructions

Update README to recommend cloning directly into ~/.claude/skills/humanizer and provide a copy-only SKILL.md option. Add WARP.md with repo-specific guidance for Warp.

Co-Authored-By: Warp <agent@warp.dev>
blader před 5 měsíci
rodič
revize
9a0575f963
2 změnil soubory, kde provedl 60 přidání a 14 odebrání
  1. 7 14
      README.md
  2. 53 0
      WARP.md

+ 7 - 14
README.md

@@ -4,29 +4,22 @@ A Claude Code skill that removes signs of AI-generated writing from text, making
 
 ## Installation
 
-### From GitHub (recommended)
+### Recommended (clone directly into Claude Code skills directory)
 
 ```bash
-# Clone the repository
-git clone https://github.com/blader/humanizer.git
-
-# Copy to Claude Code skills directory
 mkdir -p ~/.claude/skills
-cp -r humanizer ~/.claude/skills/
+git clone https://github.com/blader/humanizer.git ~/.claude/skills/humanizer
 ```
 
-### One-liner
+### Manual install/update (only the skill file)
+
+If you already have this repo cloned (or you downloaded `SKILL.md`), copy the skill file into Claude Code’s skills directory:
 
 ```bash
-git clone https://github.com/blader/humanizer.git ~/.claude/skills/humanizer
+mkdir -p ~/.claude/skills/humanizer
+cp SKILL.md ~/.claude/skills/humanizer/
 ```
 
-### Manual download
-
-1. Download `SKILL.md` from https://github.com/blader/humanizer
-2. Create the skills directory: `mkdir -p ~/.claude/skills/humanizer`
-3. Copy the file: `cp SKILL.md ~/.claude/skills/humanizer/`
-
 ## Usage
 
 In Claude Code, invoke the skill:

+ 53 - 0
WARP.md

@@ -0,0 +1,53 @@
+# WARP.md
+
+This file provides guidance to WARP (warp.dev) when working with code in this repository.
+
+## What this repo is
+This repository is a **Claude Code skill** implemented entirely as Markdown.
+
+The “runtime” artifact is `SKILL.md`: Claude Code reads the YAML frontmatter (metadata + allowed tools) and the prompt/instructions that follow.
+
+`README.md` is for humans: installation, usage, and a compact overview of the patterns.
+
+## Key files (and how they relate)
+- `SKILL.md`
+  - The actual skill definition.
+  - Starts with YAML frontmatter (`---` … `---`) containing `name`, `version`, `description`, and `allowed-tools`.
+  - After the frontmatter is the editor prompt: the canonical, detailed pattern list with examples.
+- `README.md`
+  - Installation and usage instructions.
+  - Contains a summarized “24 patterns” table and a short version history.
+
+When changing behavior/content, treat `SKILL.md` as the source of truth, and update `README.md` to stay consistent.
+
+## Common commands
+### Install the skill into Claude Code
+Recommended (clone directly into Claude Code skills directory):
+```bash
+mkdir -p ~/.claude/skills
+git clone https://github.com/blader/humanizer.git ~/.claude/skills/humanizer
+```
+
+Manual install/update (only the skill file):
+```bash
+mkdir -p ~/.claude/skills/humanizer
+cp SKILL.md ~/.claude/skills/humanizer/
+```
+
+## How to “run” it (Claude Code)
+Invoke the skill:
+- `/humanizer` then paste text
+
+## Making changes safely
+### Versioning (keep in sync)
+- `SKILL.md` has a `version:` field in its YAML frontmatter.
+- `README.md` has a “Version History” section.
+
+If you bump the version, update both.
+
+### Editing `SKILL.md`
+- Preserve valid YAML frontmatter formatting and indentation.
+- Keep the pattern numbering stable unless you’re intentionally re-numbering (since the README table and examples reference the same numbering).
+
+### Documenting non-obvious fixes
+If you change the prompt to handle a tricky failure mode (e.g., a repeated mis-edit or an unexpected tone shift), add a short note to `README.md`’s version history describing what was fixed and why.