Skip to content

docs: improve README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
webbrain-one wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


# Techfinite MVP - Technology Solutions Website

## 🚀 Quick Start (2 Hour MVP)
Expand Down Expand Up @@ -26,9 +28,12 @@ This is a rapid MVP (Minimum Viable Product) for Techfinite's technology solutio

### Method 1: Python Server (Recommended)
```bash
# Using the custom server script
# Using the custom server script (default port: 8000)
python3 server.py

# Specify a custom port if 8000 is busy (e.g., 8080)
python3 server.py 8080
Comment on lines +34 to +35

@coderabbitai coderabbitai Bot Aug 11, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Document the access URL for the custom port.

After running python3 server.py 8080, the server listens on port 8080, but Lines 58-59 still specify port 8000. Add the custom-port URL or state that readers must replace 8000 with the selected port.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 34 - 35, Update the README instructions surrounding
the custom `python3 server.py 8080` command and the access URL so they
explicitly use port 8080 or tell readers to replace 8000 with their selected
custom port.


# Or using npm scripts
npm start

Expand Down Expand Up @@ -184,4 +189,4 @@ The contact form is ready for backend integration. To connect to your email serv

**Built by MiniMax Agent** - A comprehensive technology showcase MVP ready for immediate deployment and further development.

🚀 **Ready to launch in under 2 hours!**
🚀 **Ready to launch in under 2 hours!**