Refine README clarity and onboarding flow.

Reframe the project value proposition, tighten feature and privacy sections, and update setup details so first-time contributors and users can understand and run the product faster.

Made-with: Cursor

Author: dotsystemsdevs

README.md

@@ -1,3 +1,4 @@
+<<<<<<< HEAD
 # Commitment Issues
 
 Official death certificates for abandoned GitHub repositories.
@@ -10,9 +11,36 @@ Official death certificates for abandoned GitHub repositories.
 ## What is Commitment Issues?
 
 Paste a public GitHub repository URL and get a shareable **Certificate of Death**: a tongue-in-cheek summary of how “dead” the repo looks, with a score, cause of death, last words, and exportable graphics for social posts. No account required.
+=======
+# commitmentissues.dev
 
-## Features
+Official death certificates for abandoned GitHub repositories.
+
+**Live:** [https://commitmentissues.dev](https://commitmentissues.dev)
+
+[![MIT License](https://img.shields.io/github/license/dotsystemsdevs/commitmentissues?style=flat-square)](LICENSE)
+![Vercel Deploy](https://img.shields.io/badge/deployed%20on-Vercel-black?style=flat-square&logo=vercel)
+
+Paste a public GitHub repository URL and get a shareable **Certificate of Death** with a score, cause of death, last words, and export-ready visuals.
+
+## What Is Commitment Issues?
 
+Commitment Issues is a tongue-in-cheek product for developers and founder communities. It analyzes public repository signals and generates a stylized death certificate for repos that look abandoned.
+
+No account required.
+
+## Core Features
+
+- Certificate of Death sheet (cause, last words, score, repo age, derived stats)
+- Export formats for social platforms (feed, square, story-style)
+- Mobile-friendly sharing
+- Hall of Shame (curated leaderboard)
+- Recently Buried (recent public burials feed)
+>>>>>>> ab3e4b0 (Refine README clarity and onboarding flow.)
+
+## How It Works
+
+<<<<<<< HEAD
 - **Certificate of Death** — A4-style layout with cause, last words, repo age, and derived stats
 - **Exports** — Multiple aspect ratios (feed, square, story-style) for common social platforms
 - **Mobile share** — Native share uses a tall story-friendly format on small screens to reduce bad crops
@@ -43,10 +71,17 @@ Certificate:
 About:
 
 ![About page screenshot](docs/screenshots/about.png)
+=======
+1. User pastes a public GitHub repo URL.
+2. App fetches public repo metadata from the GitHub API.
+3. Scoring and narrative are computed in `src/lib/scoring.ts`.
+4. Certificate is rendered and can be exported/shared.
+>>>>>>> ab3e4b0 (Refine README clarity and onboarding flow.)
 
 ## Privacy
 
 - No login required
+<<<<<<< HEAD
 - Only public GitHub data is used
 - Recently Buried stores recent public burial entries (repo, cause, score, timestamp)
 - Anonymous aggregate analytics may be used for product metrics
@@ -62,6 +97,24 @@ About:
 | Data | GitHub public API |
 
 ## Getting started
+=======
+- Uses only public GitHub data
+- Recently Buried stores public burial entries (repo, cause, score, timestamp)
+- Anonymous aggregate analytics may be used for product metrics
+
+## Tech Stack
+
+| Area | Choice |
+|---|---|
+| Framework | Next.js 14 (App Router) |
+| Styling | Tailwind CSS |
+| Fonts | UnifrakturMaguntia, Courier Prime, Inter |
+| Hosting | Vercel |
+| Storage | Upstash Redis (usage counters + recent burials) |
+| Data source | GitHub Public API |
+
+## Getting Started
+>>>>>>> ab3e4b0 (Refine README clarity and onboarding flow.)
 
 ```bash
 git clone https://github.com/dotsystemsdevs/commitmentissues.git
@@ -72,29 +125,45 @@ npm run dev
 
 Open [http://localhost:3000](http://localhost:3000).
 
+<<<<<<< HEAD
 ### Environment
 
 Optional: add a GitHub token to raise API rate limits.
+=======
+### Optional Environment
+
+Use a GitHub token to raise API rate limits in local dev:
+>>>>>>> ab3e4b0 (Refine README clarity and onboarding flow.)
 
 ```env
 GITHUB_TOKEN=ghp_yourtoken
 ```
 
+<<<<<<< HEAD
 Create a token under GitHub **Settings → Developer settings → Personal access tokens**. Fine-grained tokens work if you limit scope to what this app needs; classic tokens are also fine for local dev.
 
 ## Testing
+=======
+## Scripts
+>>>>>>> ab3e4b0 (Refine README clarity and onboarding flow.)
 
 ```bash
+npm run dev
+npm run build
 npm test
 ```
 
+<<<<<<< HEAD
 ## Contributing
 
 - Read `.github/CONTRIBUTING.md` before opening a PR
 - Use the issue and PR templates
 - CI runs lint, tests, and build on pull requests to `master`
 
 ## Project structure
+=======
+## Project Structure
+>>>>>>> ab3e4b0 (Refine README clarity and onboarding flow.)
 
 ```text
 src/
@@ -118,16 +187,29 @@ src/
     └── types.ts
 ```
 
+<<<<<<< HEAD
 Scoring logic lives in `src/lib/scoring.ts` so it stays easy to test and change.
 
+=======
+>>>>>>> ab3e4b0 (Refine README clarity and onboarding flow.)
 ## Docs
 
 - Release notes: `docs/releases/`
 - Screenshots: `docs/screenshots/`
 - Repository conventions: `docs/repository-conventions.md`
 
+<<<<<<< HEAD
 ## License
 
 MIT — see repository license file.
+=======
+## Screenshots
+
+Add/update screenshots in:
+
+- `docs/screenshots/home.png`
+- `docs/screenshots/certificate.png`
+- `docs/screenshots/about.png`
+>>>>>>> ab3e4b0 (Refine README clarity and onboarding flow.)
 
 Built by [Dot Systems](https://github.com/dotsystemsdevs).