docs: update README from default nextjs one

2026-09-28 22:11:48 +02:00
parent 9e734f29b8
commit fe129bc92e
1 changed files with 37 additions and 24 deletions
@@ -1,31 +1,44 @@
-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).
+# Woiken Website

-## Getting Started
+The landing page for [woiken.com](https://woiken.com), a coming-soon page for Woiken.

-First, run the development server:
+It's a single page built with Next.js 16 and exported as static files. Scrolling opens a
+framed sky photo up to full screen, where the "A new cloud, coming soon." tagline fades in.

-```bash
-pnpm install
-pnpm dev
+## Commands
+
+| Command                    | Action                                              |
+| :------------------------- | :-------------------------------------------------- |
+| `pnpm install`             | Install dependencies                                |
+| `pnpm dev`                 | Start the dev server at `localhost:3000`            |
+| `pnpm build`               | Build the static site to `./out/`                   |
+| `pnpm lint`                | Lint with ESLint                                    |
+| `pnpm exec wrangler dev`   | Serve `./out/` locally the way Cloudflare will      |
+
+Use pnpm 12. `pnpm start` doesn't work, because the site is a static export (`output: "export"`).
+
+## Project structure
+
+```
+.
+├── app/
+│   ├── page.tsx              # The landing page
+│   ├── layout.tsx
+│   └── globals.css           # Tailwind + photo darkening
+├── components/
+│   └── ScrollExpand/         # Scroll-to-expand hero (from React Bits)
+├── public/
+│   └── grass-field.jpg       # Hero photo
+├── wrangler.jsonc            # Cloudflare Worker config
+└── .gitea/workflows/deploy.yml
 ```

-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## Deployment

-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+Every push to `main` deploys the site via `.gitea/workflows/deploy.yml`. The workflow builds
+the site and runs `wrangler deploy`, which uploads `./out/` as static assets to the
+`woiken-website` Worker on the `woiken.com` custom domain.
+## Credits

-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.
-
-## Learn More
-
-To learn more about Next.js, take a look at the following resources:
-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
-
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
-
-## 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.
-
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
+Hero photo: [grass field at daytime](https://unsplash.com/photos/grass-field-at-daytime-PEm_sLmJT-w)
+on Unsplash.