patchy-cli 0.0.3 → 0.0.4

package/README.md

@@ -1,38 +1,61 @@
 # patchy
 
-An opinionated command-line tool for managing Git patch workflows.
+An opinionated command-line tool for managing Git patch workflows. 
 
 ## How it works
 
-1. Clone repo → `~/target-1`
-2. Make some edits (the patches!)
-3. Create a repo for your patches → `~/my-patches`
-3. `patchy generate --repo ~/target-1` → Creates `~/my-patches/patches/*.diff`
+Patchy helps you manage `.diff` patches for a repository you want to modify.
 
-Then reapply your changes later with:
-
-5. `patchy apply --repo ~/target-1` → `~/target-1` (patches applied)
+`patchy.json` (see [full config reference](#patchyjson) below)
+```json5
+{
+  "repo_url": "https://github.com/octocat/spoon-knife",
+  "patches_dir": "./patches/",
+  "clones_dir": "./clones/",
+  "repo_dir": "spoon-knife",
+}
+```
 
+Initialize Patchy with:
+```bash
+patchy init
+```
 
-### `patches/` folder structure
+You can `patchy repo clone` the repo into `./clones/` to complete the setup.
 
-Patch files are stored in the same folder structure as the target repo:
+Now you'll have
 
 ```
-~/target-1/
-└── path/in/repo/existingFile.txt
+./
+├── patches/
+├── clones/
+│   └── spoon-knife/
+│       ├── path/to/existingFile.txt
+└── patchy.json
 ```
 
+Now you can make changes directly to `./clones/spoon-knife`
+
+And generate patches with `patchy generate`
+
 ```
-my-patch-repo/
+./
+├── clones/
+│   └── spoon-knife/
+│       ├── path/to/existingFile.txt
+│       └── path/to/newFile.txt
 ├── patches/
-│   ├── path/in/repo/existingFile.txt.diff
-│   └── path/in/repo/newFile.txt
+│   ├── path/to/existingFile.txt.diff
+│   └── path/to/newFile.txt
 └── patchy.json
 ```
 
 - **Edits** are stored as `.diff` files e.g. `existingFile.txt.diff`.
-- **New files** are stored as regular files e.g. `newFile.txt`. 
+- **New files** are copied as regular files e.g. `newFile.txt`. 
+
+You can reapply your changes later with:
+
+`patchy apply`
 
 ### `patchy.json`
 
@@ -63,26 +86,22 @@ Precedence: CLI flags > Environment variables > `patchy.json`
 
 ```sh
 curl -fsSL https://raw.githubusercontent.com/richardgill/patchy/main/install | bash
+# follow instructions
+patchy
 ```
 
 Or via npm:
 
-**Install script (recommended):**
-
-```sh
-curl -fsSL https://raw.githubusercontent.com/richardgill/patchy/main/install | bash
-```
-
-**Via npm:**
 
 ```sh
 npm install -g patchy-cli
+patchy-cli
 ```
 
 Or use directly without installing:
 
 ```sh
-npx patchy-cli --version
+npx patchy-cli@latest
 ```
 
 ### Initialize patchy

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "patchy-cli",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "A CLI tool for managing Git patch workflows.",
   "type": "module",
   "bin": {
@@ -60,11 +60,11 @@
     "url": "https://github.com/richardgill/patchy"
   },
   "optionalDependencies": {
-    "patchy-cli-linux-x64": "0.0.3",
-    "patchy-cli-linux-arm64": "0.0.3",
-    "patchy-cli-darwin-x64": "0.0.3",
-    "patchy-cli-darwin-arm64": "0.0.3",
-    "patchy-cli-windows-x64": "0.0.3"
+    "patchy-cli-linux-x64": "0.0.4",
+    "patchy-cli-linux-arm64": "0.0.4",
+    "patchy-cli-darwin-x64": "0.0.4",
+    "patchy-cli-darwin-arm64": "0.0.4",
+    "patchy-cli-windows-x64": "0.0.4"
   },
   "publishConfig": {
     "access": "public"