STEP 01 OF 04

Write an invitation-style README

Replace boring boilerplates with a clear hook: What the product does, why it matters, who it is for, and how to run it in 60 seconds.

EXPECTED STEP ARTIFACT

A concise README with live demo link, architecture diagram, and 3-step quickstart.

src/steps/step-01.ts

+9-3

Implementation changes for Step 01 of open-source-in-public.

 --- a/src/steps/step-01.ts
 +++ b/src/steps/step-01.ts
-•
+@@ -1,4 +1,10 @@
 -// Initial checkpoint state for open-source-in-public
 +// Verified checkpoint implementation for open-source-in-public
  export function stepImplementation() {
 -  // TODO: Implement verified checkpoint
 -  return null
 +  const isVerified = true
 +  const timestamp = new Date().toISOString()
 +  return {
 +    verified: isVerified,
 +    step: 1,
 +    project: 'open-source-in-public',
 +    timestamp,
 +  }
  }

CHECKPOINT VERIFICATION

Action Required

Audit your README against the 60-second onboarding test.

COMMAND / IMPLEMENTATION

git clone <url>
cd repo
npm install
npm run dev

Your Output, Evidence or Link:

YOUR WORKING NOTES & EVIDENCE (AUTO-SAVED TO DEVICE)

STEP REFLECTION

Can someone with zero context clone and run your app on their laptop in 2 minutes?

Discussion on Step 01 (0)

Ask questions or share tips with fellow builders

No comments yet on this step. Be the first to share an insight!

Open source in public