cornhsu-polymigrate 1.1.2 → 2.0.1

package/README.md

@@ -13,10 +13,12 @@ PolyMigrate turns legacy dynamic sites (old PHP sites and the like) into clean,
 Markdown — and it treats multilingual content as a first-class concern, not an afterthought.
 Config-driven, fully offline-rerunnable, built on .NET.
 
-**Status: 1.0.** The extraction pipeline, pairing, verification, thumbnails and orphan-page
-recovery are complete and validated against a real full-site migration (see below). The CLI
-surface and the Phase output contracts are now stable: new features bump the minor version,
-fixes bump the patch version.
+**Status: 2.0.** The extraction pipeline, pairing, verification, thumbnails and orphan-page
+recovery are complete and validated against a real full-site migration (see below). The **CLI
+surface and the Phase output contracts remain stable** (unchanged since 1.0): new features bump
+the minor version, fixes bump the patch. 2.0 is an engineering release — it narrowed the
+`Cornhsu.PolyMigrate.Core` public .NET API to its intended entry points and removed unused
+config fields; see the [CHANGELOG](CHANGELOG.md) for the migration notes.
 
 ## Why
 
@@ -98,6 +100,9 @@ polymigrate probe-orphans site.yaml --section news --years 2021-2023
 polymigrate fetch-orphans site.yaml --section news
 ```
 
+> No .NET? Every command above also runs with **zero install** via npm — just prefix it:
+> `npx cornhsu-polymigrate extract site.yaml`, `npx cornhsu-polymigrate verify out/`, and so on.
+
 One YAML config per site describes everything site-specific — see
 [examples/ibps-austin.yaml](examples/ibps-austin.yaml) for a fully-annotated real example.
 
@@ -112,18 +117,38 @@ url_pattern:
 extract:
   content: "section[id]:not(#header):not(#footer)"
 pairing:
-  strategy: symmetric_path
   fallback: [shared_media, date, title_similarity]
 ```
 
+## Use as a library
+
+The CLI is a thin shell over `Cornhsu.PolyMigrate.Core`. To drive a migration from your own
+.NET code, use the `PolyMigrator` facade — the single documented entry point:
+
+```
+dotnet add package Cornhsu.PolyMigrate.Core
+```
+
+```csharp
+using PolyMigrate.Core;
+
+var migrator = PolyMigrator.FromConfigFile("site.yaml");
+var report = migrator.Extract("out/");        // out/raw, out/media -> out/content + inventories
+if (report.HasErrors) { /* unsafe paths were skipped; see path_issues.csv */ }
+
+var verify = PolyMigrator.Verify("out/");      // no config needed; reads Phase 2 output only
+Console.WriteLine($"{verify.Errors} errors, {verify.Warnings} warnings");
+```
+
 ## Layout
 
 | Path | Contents |
 |---|---|
 | `src/PolyMigrate.Core` | extraction / pairing / verification library (NuGet: `Cornhsu.PolyMigrate.Core`) |
 | `src/PolyMigrate.Cli` | the `polymigrate` CLI (NuGet tool package: `Cornhsu.PolyMigrate`) |
-| `tests/` | 119 unit/integration tests + an offline fixture site with golden-file baselines |
+| `tests/` | unit/integration tests + an offline fixture site with golden-file baselines |
 | `docs/contracts.md` | file-format contracts between pipeline phases |
+| `docs/搬遷工具_評估與規劃書.md` | the original design/planning doc (the `§X.Y` references throughout the source point here) |
 
 ## Development
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cornhsu-polymigrate",
-  "version": "1.1.2",
+  "version": "2.0.1",
   "description": "The i18n-first static-site migrator — the only one that pairs your multilingual pages automatically. Mirrors a legacy site into frontmatter Markdown, auto-matches language versions, and honestly lists what it could not pair.",
   "keywords": [
     "i18n",
@@ -35,9 +35,9 @@
     "node": ">=18"
   },
   "optionalDependencies": {
-    "@cornhsu/polymigrate-win32-x64": "1.1.2",
-    "@cornhsu/polymigrate-linux-x64": "1.1.2",
-    "@cornhsu/polymigrate-darwin-x64": "1.1.2",
-    "@cornhsu/polymigrate-darwin-arm64": "1.1.2"
+    "@cornhsu/polymigrate-win32-x64": "2.0.1",
+    "@cornhsu/polymigrate-linux-x64": "2.0.1",
+    "@cornhsu/polymigrate-darwin-x64": "2.0.1",
+    "@cornhsu/polymigrate-darwin-arm64": "2.0.1"
   }
 }