readme

README.md

@@ -1 +1,20 @@
-# BlazorStaticMinimalBlog
+# BlazorStatic Minimal Blog
+
+A minimalistic blog template designed to get your Blazor-based blog up and running in no time. This project leverages the [BlazorStatic](https://github.com/tesar-tech/BlazorStatic) library to convert a Blazor app into a static site generator
+## Features
+
+- **Quick Setup**: Deploy your blog within minutes using this template.
+- **BlazorStatic Integration**: Harness the power of Blazor and BlazorStatic library for generating static sites
+- **Customizable**: Easy to edit content, update styling, and tweak configurations to suit your blogging needs.
+- **GitHub Actions Workflow**: Includes setup for automatic publishing using GitHub Actions, facilitating seamless deployment.
+
+## Getting Started
+
+1. **Fork or Clone**: Start by forking or cloning this repository.
+2. **Enable GitHub Pages**: Configure GitHub Pages in your repository settings for quick deployment.
+3. **Personalize**: Update the content, modify styling, and adjust configurations to personalize your blog.
+4. **Deploy**: Push your changes, and GitHub Actions will take care of the deployment process.
+
+## Acknowledgements
+
+The theme for BlazorStaticMinimalBlog was heavily inspired by [Tailwind Next.js Starter Blog](https://github.com/timlrx/tailwind-nextjs-starter-blog).