Update README.md

Author: Sarbani-Roy

README.md

@@ -1,17 +1,66 @@
+# PUMA Dashboard 🚀
+
+A web interface for managing, viewing and curating publications metadata via the PUMA backend.  
+You can browse all posts, filter by tags or status, detect duplicates, and reconcile duplicates with a merge‑tag UI.
+
+**Live demo available at:** [puma-dashboard.vercel.app](https://puma-dashboard.vercel.app/allPostsSimtech)
+
+---
+
+## Features
+
+- **All Posts View** — browse and paginate all entries of a group (e.g. “simtech”, “simtech_test”, …).  
+- **Tag / Status Filters** — filter posts by tags (e.g. “updated”, “in-review”, “curated”).  
+- **Duplicate Detection** — automatically show potentially duplicate (or related) posts for a given entry, based on similarity of metadata.  
+- **Duplicate Resolution UI** — a detailed, side‑by‑side view of a post and its duplicates; allows merging metadata, selecting tags, and deleting duplicates.  
+- **Sidebar Navigation** — consistent layout with navigation links for different views & workflows (All Posts, filters, duplicates, etc.).  
+
+---
+
+## Code Structure / Important Pages
+
+- **Duplicate Checking** — `app/[intrahash]/components/relatedposts.tsx`  
+- **Detailed Duplicate View & Merge UI** — `app/duplicates/[intrahash]/page.tsx`  
+- **Global Layout & Sidebar** — `app/layout.tsx`  
+- **Landing Pages for Sidebar Options** — `app/__option__/page.tsx` (where `__option__` stands for each sidebar route)  
+- **All Posts / Posts Lists** — e.g. `allPostsSimtech` view (as deployed)  
+
+---
+
 ## Getting Started
 
-First, run the development server:
+1. Clone the repository  
+2. Install dependencies  
+3. Configure your backend (PUMA) credentials / API endpoint  
+4. Run the development server (via Next.js)  
+5. Navigate to `All Posts` and explore posts, filters, duplicate detection, etc.  
+
+---
+
+## Usage / Workflow
+
+- Use the “All Posts” view to browse all entries of a group.  
+- Use tag filters (e.g. “updated”, “in‑review”, “curated”) to narrow down subsets of posts.  
+- Click on a post to open the duplicate-checking panel — see similar / related items.  
+- If duplicates are detected, open the detailed duplicate view — choose which version to keep, merge metadata or tags, and delete duplicates.  
+
+---
+
+## Why Use PUMA Dashboard
+
+- Helps managing publication metadata at scale — tag, organize, curate easily.  
+- Supports deduplication: avoids multiple entries of the same paper, ensures clean dataset.  
+- Enables collaborative curation workflows, with an easy UI for merge/tag/delete decisions.  
+
+---
+
+## Live Demo
+
+See the working application here: [https://puma-dashboard.vercel.app](https://puma-dashboard.vercel.app)  
+
+---
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+## Contributing
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the results.
+Contributions welcome! Feel free to open issues or pull requests to fix bugs, improve duplicate detection, enhance UI/UX, or add new features.  
 
-Group credentials are needed for authenticating PUT request.