Skip to content

Commit 5665a26

Browse files
dotsystemsdevsdotsystemsdevs
committed
docs: resolve README merge markers on master
1 parent a68788c commit 5665a26

1 file changed

Lines changed: 27 additions & 109 deletions

File tree

‎README.md‎

Lines changed: 27 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
<<<<<<< HEAD
21
# Commitment Issues
32

43
Official death certificates for abandoned GitHub repositories.
@@ -10,42 +9,15 @@ Official death certificates for abandoned GitHub repositories.
109

1110
## What is Commitment Issues?
1211

13-
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.
14-
=======
15-
# commitmentissues.dev
12+
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.
1613

17-
Official death certificates for abandoned GitHub repositories.
18-
19-
**Live:** [https://commitmentissues.dev](https://commitmentissues.dev)
20-
21-
[![MIT License](https://img.shields.io/github/license/dotsystemsdevs/commitmentissues?style=flat-square)](LICENSE)
22-
![Vercel Deploy](https://img.shields.io/badge/deployed%20on-Vercel-black?style=flat-square&logo=vercel)
23-
24-
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.
25-
26-
## What Is Commitment Issues?
14+
## Features
2715

28-
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.
29-
30-
No account required.
31-
32-
## Core Features
33-
34-
- Certificate of Death sheet (cause, last words, score, repo age, derived stats)
35-
- Export formats for social platforms (feed, square, story-style)
36-
- Mobile-friendly sharing
37-
- Hall of Shame (curated leaderboard)
38-
- Recently Buried (recent public burials feed)
39-
>>>>>>> ab3e4b0 (Refine README clarity and onboarding flow.)
40-
41-
## How It Works
42-
43-
<<<<<<< HEAD
44-
- **Certificate of Death** — A4-style layout with cause, last words, repo age, and derived stats
45-
- **Exports** — Multiple aspect ratios (feed, square, story-style) for common social platforms
46-
- **Mobile share** — Native share uses a tall story-friendly format on small screens to reduce bad crops
47-
- **Hall of Shame** — Curated leaderboard of famously abandoned repositories
48-
- **Recently Buried** — Live feed of the latest public burials (repo, cause, score, time)
16+
- **Certificate of Death** - A4-style layout with cause, last words, repo age, and derived stats
17+
- **Exports** - Multiple aspect ratios (feed, square, story-style) for common social platforms
18+
- **Mobile share** - Native share uses a tall story-friendly format on small screens to reduce bad crops
19+
- **Hall of Shame** - Curated leaderboard of famously abandoned repositories
20+
- **Recently Buried** - Live feed of the latest public burials (repo, cause, score, time)
4921

5022
## How scoring works (high level)
5123

@@ -71,17 +43,10 @@ Certificate:
7143
About:
7244

7345
![About page screenshot](docs/screenshots/about.png)
74-
=======
75-
1. User pastes a public GitHub repo URL.
76-
2. App fetches public repo metadata from the GitHub API.
77-
3. Scoring and narrative are computed in `src/lib/scoring.ts`.
78-
4. Certificate is rendered and can be exported/shared.
79-
>>>>>>> ab3e4b0 (Refine README clarity and onboarding flow.)
8046

8147
## Privacy
8248

8349
- No login required
84-
<<<<<<< HEAD
8550
- Only public GitHub data is used
8651
- Recently Buried stores recent public burial entries (repo, cause, score, timestamp)
8752
- Anonymous aggregate analytics may be used for product metrics
@@ -97,24 +62,6 @@ About:
9762
| Data | GitHub public API |
9863

9964
## Getting started
100-
=======
101-
- Uses only public GitHub data
102-
- Recently Buried stores public burial entries (repo, cause, score, timestamp)
103-
- Anonymous aggregate analytics may be used for product metrics
104-
105-
## Tech Stack
106-
107-
| Area | Choice |
108-
|---|---|
109-
| Framework | Next.js 14 (App Router) |
110-
| Styling | Tailwind CSS |
111-
| Fonts | UnifrakturMaguntia, Courier Prime, Inter |
112-
| Hosting | Vercel |
113-
| Storage | Upstash Redis (usage counters + recent burials) |
114-
| Data source | GitHub Public API |
115-
116-
## Getting Started
117-
>>>>>>> ab3e4b0 (Refine README clarity and onboarding flow.)
11865

11966
```bash
12067
git clone https://github.com/dotsystemsdevs/commitmentissues.git
@@ -125,92 +72,63 @@ npm run dev
12572

12673
Open [http://localhost:3000](http://localhost:3000).
12774

128-
<<<<<<< HEAD
12975
### Environment
13076

13177
Optional: add a GitHub token to raise API rate limits.
132-
=======
133-
### Optional Environment
134-
135-
Use a GitHub token to raise API rate limits in local dev:
136-
>>>>>>> ab3e4b0 (Refine README clarity and onboarding flow.)
13778

13879
```env
13980
GITHUB_TOKEN=ghp_yourtoken
14081
```
14182

142-
<<<<<<< HEAD
143-
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.
83+
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.
14484

14585
## Testing
146-
=======
147-
## Scripts
148-
>>>>>>> ab3e4b0 (Refine README clarity and onboarding flow.)
14986

15087
```bash
151-
npm run dev
152-
npm run build
15388
npm test
15489
```
15590

156-
<<<<<<< HEAD
15791
## Contributing
15892

15993
- Read `.github/CONTRIBUTING.md` before opening a PR
16094
- Use the issue and PR templates
16195
- CI runs lint, tests, and build on pull requests to `master`
16296

16397
## Project structure
164-
=======
165-
## Project Structure
166-
>>>>>>> ab3e4b0 (Refine README clarity and onboarding flow.)
16798

16899
```text
169100
src/
170-
├── app/
171-
│ ├── page.tsx
172-
│ ├── about/
173-
│ ├── terms/
174-
│ └── api/
175-
│ ├── repo/
176-
│ ├── stats/
177-
│ └── recent/
178-
├── components/
179-
│ ├── CertificateCard.tsx
180-
│ ├── Leaderboard.tsx
181-
│ ├── SearchForm.tsx
182-
│ └── LoadingState.tsx
183-
└── lib/
184-
├── scoring.ts
185-
├── rateLimit.ts
186-
├── recentStore.ts
187-
└── types.ts
101+
+-- app/
102+
¦ +-- page.tsx
103+
¦ +-- about/
104+
¦ +-- terms/
105+
¦ +-- api/
106+
¦ +-- repo/
107+
¦ +-- stats/
108+
¦ +-- recent/
109+
+-- components/
110+
¦ +-- CertificateCard.tsx
111+
¦ +-- Leaderboard.tsx
112+
¦ +-- SearchForm.tsx
113+
¦ +-- LoadingState.tsx
114+
+-- lib/
115+
+-- scoring.ts
116+
+-- rateLimit.ts
117+
+-- recentStore.ts
118+
+-- types.ts
188119
```
189120

190-
<<<<<<< HEAD
191121
Scoring logic lives in `src/lib/scoring.ts` so it stays easy to test and change.
192122

193-
=======
194-
>>>>>>> ab3e4b0 (Refine README clarity and onboarding flow.)
195123
## Docs
196124

197125
- Release notes: `docs/releases/`
198126
- Screenshots: `docs/screenshots/`
199127
- Repository conventions: `docs/repository-conventions.md`
200128

201-
<<<<<<< HEAD
202129
## License
203130

204-
MIT — see repository license file.
205-
=======
206-
## Screenshots
207-
208-
Add/update screenshots in:
209-
210-
- `docs/screenshots/home.png`
211-
- `docs/screenshots/certificate.png`
212-
- `docs/screenshots/about.png`
213-
>>>>>>> ab3e4b0 (Refine README clarity and onboarding flow.)
131+
MIT - see repository license file.
214132

215133
Built by [Dot Systems](https://github.com/dotsystemsdevs).
216134

0 commit comments

Comments
 (0)