From 38f70bb45ac3f4a448072215d84c6b6afa9479aa Mon Sep 17 00:00:00 2001
From: zilin <quitebig1@gmail.com>
Date: Sun, 12 May 2024 03:59:57 -0700
Subject: [PATCH] update readme.md

---
 README.md | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 4c6a7f2..4aef30c 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,35 @@
 
 Main project for CSE 110. Includes calendar, journal entries, contact pages, progression meter, a task list, all within a polish UI
 
-# Project cards
+# preview
 
+### home page
+
+# Documentation
+
+## project-card
+
+- HTML element name: `project-card`
+- JS element class: `ProductCard`
+- sample project card HTML:
+
+```HTML
+<project-card>
+  <div class="project-card">
+    <p class="name">warmup</p>
+    <img src="https://fakestoreapi.com/img/81fPKd-2AYL._AC_SL1500_.jpg" alt="warmup" class="project-image">
+    <div class="desc">a warmup project</div>
+    <div class="progress-bar">
+      <div class="progress-bar-fill" style="width: 79%;">79</div>
+    </div>
+    <div class="actions">
+      <button>progress + random</button>
+      <button>open</button>
+      <button>options</button>
+    </div>
+  </div>
+</project-card>
+```
 
 # projects.JSON