chore: rename StackSync references and clarify README

Author: benjamindotdev

README.md

@@ -38,10 +38,8 @@ stackscan
 ## Usage
 
 1.  **Prepare Input**: 
-    *   Place your project folders inside `stackscan/`.
-    *   **OR** simply drop your `package.json` files directly into `stackscan/`. 
-        *   If you have multiple, you can name them `package (1).json`, `package (2).json`, etc.
-        *   StackScan will automatically create folders based on the project name defined in each file.
+    *   Place a folder for each desired project inside `public/stackscan/`.
+    *   Each folder should contain a `package.json` file.
 2.  **Run Scan**:
 
 ```bash
@@ -60,10 +58,10 @@ npx stackscan add ./path/to/package.json
 npx stackscan add ../my-project
 ```
 
-This will copy the `package.json` into a new folder inside `stackscan/` (e.g., `stackscan/my-project/`), handling name collisions automatically.
+This will copy the `package.json` into a new folder inside `public/stackscan/` (e.g., `public/stackscan/my-project/`), handling name collisions automatically.
 
 This will:
-*   Scan all projects in `stackscan/`.
+*   Scan all projects in `public/stackscan/`.
 *   Generate `stack.json` and `stack.md` inside each project folder.
 *   Copy logo assets to `public/assets/logos/`.
 *   Update your root `README.md` with a "My Projects" section.
@@ -85,7 +83,7 @@ npx stackscan scan --color brand
 
 ## Output
 
-For each project in `stackscan/`, a `stack.json` is generated in the same folder.
+For each project in `public/stackscan/`, a `stack.json` is generated in the same folder.
 
 Example `stack.json`:
 
@@ -149,7 +147,7 @@ jobs:
 
 ---
 
-## What StackSync does *not* do
+## What StackScan does *not* do
 
 * ❌ It does not execute or analyze runtime code
 * ❌ It does not attempt to infer architectural quality

src/output.ts

@@ -2,7 +2,7 @@ import fs from "fs-extra";
 import path from "path";
 import chalk from "chalk";
 import { createRequire } from "module";
-import { DetectorResult, StackSyncConfig } from "./types";
+import { DetectorResult, StackScanConfig } from "./types";
 import { DEFAULT_CATEGORY_ICONS } from "./defaults";
 import simpleIconsHex from "./simple-icons-hex.json";
 
@@ -11,7 +11,7 @@ const require = createRequire(import.meta.url);
 export async function writeOutput(
     outPath: string,
     techs: DetectorResult[],
-    config: StackSyncConfig,
+    config: StackScanConfig,
     format: "json" | "markdown" = "json",
     assetsOutPath?: string
 ) {
@@ -50,7 +50,7 @@ export async function writeOutput(
     }
 }
 
-export async function copyAssets(techs: DetectorResult[], dest: string, config: StackSyncConfig): Promise<Set<string>> {
+export async function copyAssets(techs: DetectorResult[], dest: string, config: StackScanConfig): Promise<Set<string>> {
     // Assume assets are in ../public/assets/logos relative to this file (dist/output.js or src/output.ts)
     const srcDir = path.resolve(__dirname, "../public/assets/logos");
 

src/scan.ts

@@ -269,8 +269,8 @@ function updateRootReadme(projects: { name: string; techs: any[] }[]) {
     }
 
     let readmeContent = fs.readFileSync(readmePath, 'utf-8');
-    const startMarker = '<!-- STACKSYNC_START -->';
-    const endMarker = '<!-- STACKSYNC_END -->';
+    const startMarker = '<!-- STACKSCAN_START -->';
+    const endMarker = '<!-- STACKSCAN_END -->';
 
     let newSection = `${startMarker}\n## My Projects\n\n`;
 

src/sync.ts

@@ -177,8 +177,8 @@ function updateRootReadme(projects: { name: string; techs: any[] }[]) {
     }
 
     let readmeContent = fs.readFileSync(readmePath, 'utf-8');
-    const startMarker = '<!-- STACKSYNC_START -->';
-    const endMarker = '<!-- STACKSYNC_END -->';
+    const startMarker = '<!-- STACKSCAN_START -->';
+    const endMarker = '<!-- STACKSCAN_END -->';
 
     let newSection = `${startMarker}\n## My Projects\n\n`;
 

src/types.ts

@@ -14,7 +14,7 @@ export interface TechDefinition {
     frameworks?: string[];
 }
 
-export interface StackSyncConfig {
+export interface StackScanConfig {
     ignore?: string[];
     aliases?: Record<string, string>;
     logosPath?: string;