diff --git a/README.md b/README.md index f82fd04..2365db3 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,50 @@ SPDX-License-Identifier: CC-BY-4.0 --> # nobbz.dev personal blog and website + +This repository contains the source code for my personal blog and website at [blog.nobbz.dev](https://blog.nobbz.dev). + +## Technology Stack + +- [Astro](https://astro.build/) - Web framework +- [Tailwind CSS](https://tailwindcss.com/) - CSS framework +- [MDX](https://mdxjs.com/) - Markdown with JSX for content +- [Cloudflare Pages](https://pages.cloudflare.com/) - Hosting + +## Development + +### Prerequisites + +- [Node.js](https://nodejs.org/) (see `.tool-versions` for version) +- [Yarn](https://yarnpkg.com/) + +### Setup + +```bash +# Clone the repository +git clone https://github.com/NobbZ/blog-nobbz-dev.git +cd blog-nobbz-dev + +# Install dependencies +yarn install +``` + +### Development Commands + +```bash +# Start development server +yarn dev + +# Build for production +yarn build + +# Preview production build +yarn preview +``` + +## License + +- Code: [MIT](./LICENSES/MIT.txt) +- Content: [CC-BY-4.0](./LICENSES/CC-BY-4.0.txt) + +This project is [REUSE](https://reuse.software/) compliant.