create-projx 1.2.0 → 1.3.0

package/README.md

@@ -1,5 +1,9 @@
 # Projx
 
+[![npm version](https://img.shields.io/npm/v/create-projx)](https://www.npmjs.com/package/create-projx)
+[![CI](https://github.com/ukanhaupa/projx/actions/workflows/ci.yml/badge.svg)](https://github.com/ukanhaupa/projx/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
 Production-grade project scaffolder. Pick your stack, get a fully wired project with auth, database, CI/CD, and E2E tests — ready to deploy.
 
 ## The Problem
@@ -63,7 +67,7 @@ cd my-existing-app
 npx create-projx init
 ```
 
-Auto-detects components by scanning for `fastapi` in pyproject.toml, `react`/`fastify` in package.json, `flutter` in pubspec.yaml, and `.tf` files. Confirms each mapping, writes `.projx-component` markers, and generates only missing shared files. Existing files get a diff/overwrite/skip prompt.
+Auto-detects components by scanning for `fastapi` in pyproject.toml, `react`/`fastify` in package.json, `flutter` in pubspec.yaml, and `.tf` files. Confirms each mapping, creates a `projx/baseline` branch with the template, and merges it — preserving all your existing code while establishing the ancestry link that makes future updates work.
 
 ### Add Components Later
 
@@ -83,14 +87,23 @@ cd my-app
 npx create-projx@latest update
 ```
 
-Creates a `projx/update-vX.X.X` branch with the latest template overlay. Your custom files are never deleted — only template files are added or replaced. Merge with conflict resolution:
+Uses a `projx/baseline` branch that tracks the raw template state. When you update, the baseline advances to the new template version and merges into your branch using git's three-way merge:
+
+- **Files only the template changed** — auto-merged, no action needed
+- **Files only you changed** — preserved, untouched
+- **Files both sides changed** — git conflict, you resolve
 
 ```bash
-git diff main...projx/update-v1.1.2    # review changes
-git checkout main && git merge --no-ff projx/update-v1.1.2  # merge with conflicts
+# If conflicts occur:
+git status                    # see conflicted files
+# resolve conflicts in your editor
+git add . && git commit       # finish the merge
+
+# Or abort:
+git merge --abort
 ```
 
-Git shows conflicts on files you customized (controllers, middleware, configs). You keep your code, accept template improvements.
+Your custom files (controllers, pages, middleware) are never deleted. Files you created that don't exist in the template are always preserved.
 
 ## Options
 
@@ -178,6 +191,14 @@ npm test        # run tests
 npm run build   # build CLI
 ```
 
+## Badge
+
+Add this to your project's README:
+
+```md
+[![Built with Projx](https://img.shields.io/badge/Built%20with-Projx-blue)](https://github.com/ukanhaupa/projx)
+```
+
 ## License
 
 MIT