Improved README, Hammer Auction Style

[shadow-dawg]

This PR updates the README.md file to include comprehensive setup instructions for new developers, particularly focusing on the Project ID configuration required for local development.
Changes Made

fix #47

Added detailed Local Setup with Project ID section with step-by-step instructions
Included Learn More section with Next.js documentation resources
Added information about next/font optimization and Inter font usage
Added support for bun package manager in installation commands
Included Reown Cloud setup instructions with clear guidance on obtaining Project ID

Why These Changes?

Improves onboarding experience for new contributors
Reduces setup friction by providing clear environment variable configuration steps
Provides essential learning resources for developers new to Next.js
Maintains consistency with the original README style and structure

Summary by CodeRabbit

• Documentation
  • Revamped README into a branded multi-section landing page with header, project title, and social links.
  • Expanded Getting Started with prerequisites, installation, environment variable setup (project ID), dev-server run and browser steps.
  • Added Tech Stack overview (frontend and blockchain) and Learn More resources.
  • Added Contributing guidance covering branch/commit/PR workflow and issue/feature reporting.
  • Updated repository path/name references.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Warning

Rate limit exceeded

@shadow-dawg has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 18 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 23c4728 and 5875c4c.

📒 Files selected for processing (1)

• README.md (2 hunks)

Walkthrough

The README.md was replaced with a branded, multi-section landing page: branding/header, centered title, tech-stack outline, expanded Getting Started (prereqs, install, env var NEXT_PUBLIC_PROJECT_ID), run instructions, Learn More, and Contributing guidance; repo path updated to hodlCoin-Solidity-WebUI.

Changes

Cohort / File(s)

Summary

Documentation Update README.md

Replaced the minimal project description with a full branded README including organization branding and badges, project title and social links, a Frontend/Blockchain tech-stack outline, detailed Getting Started (prereqs, installation, env var NEXT_PUBLIC_PROJECT_ID, project ID retrieval), dev-server/run instructions, Learn More links, and Contributing guidelines; repository path updated to hodlCoin-Solidity-WebUI.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Focus areas: verify accuracy of setup/installation steps, correctness of the NEXT_PUBLIC_PROJECT_ID instructions, and validity of external links/social badges.

Possibly related issues

• #79 — Documentation Enhancement: README Needs Complete Overhaul #79: README expansion appears to address the same comprehensive documentation rewrite described in that issue.
• #47 — Improve ReadMe: Implements the requested README improvement and styling guidance referenced in the linked issue.

Poem

🐰 I hopped into the README bright,
And stitched a header, badge, and light.
A path to start, with steps in view,
NEXT_PUBLIC keys and links anew.
Hop on — the docs now lead the way! 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Improved README, Hammer Auction Style' directly references the linked issue requirement to follow the Hammer Auction House style and accurately describes the main change.
Linked Issues check	✅ Passed	The PR successfully implements the requirement from issue #47 to update the README following the Hammer Auction House style with comprehensive setup instructions and improved documentation structure.
Out of Scope Changes check	✅ Passed	All changes in the PR are directly related to improving the README documentation as required by issue #47; no out-of-scope modifications were introduced.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 4

🧹 Nitpick comments (1)

README.md (1)

143-149: Standardize step headers to use consistent markdown heading format.

"#### 5. Open your Browser" uses markdown heading format, but "Obtain Your Project ID" (line 119) uses bold emphasis instead. Ensure consistency by converting the emphasis block to a proper heading or updating this section for consistency across all numbered steps.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 787e368 and 7faa991.

📒 Files selected for processing (1)

• README.md (2 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

8-8: Images should have alternate text (alt text)

(MD045, no-alt-text)

---

119-119: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

[coderabbitai]

Actionable comments posted: 1

♻️ Duplicate comments (1)

README.md (1)

8-8: Add alt text to the hodlCoin logo image.

This image still lacks alternative text, which violates accessibility standards and markdown linting rules (MD045).

-  <img src="public/hodlcoin.svg" width="175" />
+  <img alt="hodlCoin Logo" src="public/hodlcoin.svg" width="175" />

🧹 Nitpick comments (1)

README.md (1)

54-56: Improve readability of font optimization note.

Lines 54–56 blend the project description with a font optimization detail. Consider moving the font note to a separate, clearly-labeled subsection (e.g., under a "Font Optimization" heading after the main intro) to reduce cognitive load and improve scannability.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7faa991 and 23c4728.

📒 Files selected for processing (1)

• README.md (2 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

8-8: Images should have alternate text (alt text)

(MD045, no-alt-text)

🔇 Additional comments (1)

README.md (1)

1-177: Excellent README overhaul with strong structure and onboarding clarity.

The redesigned README significantly improves the developer experience with clear sections, step-by-step instructions for Project ID setup, comprehensive tech stack documentation, and well-organized contributing guidelines. The branding header and social badges add professional polish. After fixing the two minor markdown linting issues (missing alt text and bold-as-heading), this will be an exemplary onboarding document.

[DengreSarthak]

Can you please resole the conflicts so that we can merge it?