Skip to content

docs: rewrite README with project overview, stack, and local dev steps - #55

Open
nexxeln wants to merge 1 commit into
mainfrom
nxl/feature/witty-mountain
Open

docs: rewrite README with project overview, stack, and local dev steps#55
nexxeln wants to merge 1 commit into
mainfrom
nxl/feature/witty-mountain

Conversation

@nexxeln

@nexxeln nexxeln commented Mar 11, 2026

Copy link
Copy Markdown
Owner

This PR updates README.md to provide a clearer project overview, current stack, and practical local development steps. It replaces the prior condensed status with a richer introduction and new sections for easier onboarding and contribution.

What changed

  • Replaced the short status snippet with a heading and description for nexxel.dev
  • Added sections: what's here, stack, running locally, and writing
  • Updated local development commands tobun install and bun run dev
  • Documented content layout (posts) and frontmatter requirements for posts in /posts
  • Overall improved readability and structure for new contributors and visitors

Why

  • To reflect the current project structure and tooling
  • To provide actionable guidance for running the site locally and contributing content

How to test locally (after merge)

  • Clone the repository
  • Run bun install
  • Run bun run dev and open the local site to verify the updated README sections render as described

Files affected

  • README.md (modified)

@vercel

vercel Bot commented Mar 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
nexxel Ready Ready Preview, Comment Mar 11, 2026 10:31am

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant