docs(README): enhance project overview and structure for clarity
This commit is contained in:
parent
6b4baf62d2
commit
0ef17ab093
1 changed files with 77 additions and 23 deletions
100
README.md
100
README.md
|
|
@ -1,36 +1,90 @@
|
||||||
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
|
### 1. Home / Landing
|
||||||
|
|
||||||
## Getting Started
|
**Goal:** instant context
|
||||||
|
|
||||||
First, run the development server:
|
* Name + role
|
||||||
|
*“Software Developer focused on X”*
|
||||||
|
* 1-line value statement
|
||||||
|
*“I build reliable backend systems and clean UIs.”*
|
||||||
|
* Primary CTA: **View Projects** or **GitHub**
|
||||||
|
|
||||||
```bash
|
---
|
||||||
npm run dev
|
|
||||||
# or
|
|
||||||
yarn dev
|
|
||||||
# or
|
|
||||||
pnpm dev
|
|
||||||
# or
|
|
||||||
bun dev
|
|
||||||
```
|
|
||||||
|
|
||||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
### 2. Projects (most important page)
|
||||||
|
|
||||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
**This is where hiring decisions start.**
|
||||||
|
|
||||||
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
|
For each project:
|
||||||
|
|
||||||
## Learn More
|
* **What it is** (1 sentence)
|
||||||
|
* **Tech stack**
|
||||||
|
* **Your role** (solo / team / size)
|
||||||
|
* **Key challenges & decisions**
|
||||||
|
* **What you’d improve next**
|
||||||
|
|
||||||
To learn more about Next.js, take a look at the following resources:
|
Examples:
|
||||||
|
|
||||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
* “Self-hosted document management system (Docker, Python, PostgreSQL)”
|
||||||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
* “Matrix server setup & federation experiments”
|
||||||
|
* “WPF app solving UI threading issues”
|
||||||
|
|
||||||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
|
👉 3–5 *good* projects beat 10 shallow ones.
|
||||||
|
|
||||||
## Deploy on Vercel
|
---
|
||||||
|
|
||||||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
|
### 3. About (technical, not fluffy)
|
||||||
|
|
||||||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
|
Think “senior dev intro”, not life story.
|
||||||
|
|
||||||
|
Include:
|
||||||
|
|
||||||
|
* What kind of problems you enjoy solving
|
||||||
|
* How you approach learning & debugging
|
||||||
|
* What environments you work best in
|
||||||
|
|
||||||
|
Keep it to ~2 short paragraphs.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 4. Skills / Tech Stack
|
||||||
|
|
||||||
|
**Grouped, not buzzword soup.**
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
* **Languages:** …
|
||||||
|
* **Frameworks:** …
|
||||||
|
* **Infrastructure / DevOps:** Docker, Linux, CI/CD
|
||||||
|
* **Databases:** …
|
||||||
|
* **Concepts:** REST, async, threading, security basics
|
||||||
|
|
||||||
|
Bonus points:
|
||||||
|
|
||||||
|
* “Comfortable with” vs “Familiar with”
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 5. Experience
|
||||||
|
|
||||||
|
* Jobs, freelance, serious hobby projects
|
||||||
|
* Focus on **impact**, not duties
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
> “Maintained and extended internal tooling used by X users”
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 6. Resume (PDF)
|
||||||
|
|
||||||
|
* One click download
|
||||||
|
* Matches the portfolio (no contradictions)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 7. Contact
|
||||||
|
|
||||||
|
* Email
|
||||||
|
* GitHub
|
||||||
|
* LinkedIn
|
||||||
|
* (Optional) location / timezone
|
||||||
Loading…
Add table
Reference in a new issue