Update README.md with enhanced features section, installation instructions, and favicon details; add favicon links in layout.tsx

2025-06-16 19:46:53 +02:00
parent b82f48ef4f
commit 500695d471
9 changed files with 79 additions and 50 deletions
--- a/README.md
+++ b/README.md
@@ -1,48 +1,60 @@
 # Markdown Blog

-A modern blog system built with Next.js, Markdown, and Electron for cross-platform support.
+[![Next.js](https://img.shields.io/badge/Next.js-14-black?style=flat-square&logo=next.js&logoColor=white)](https://nextjs.org/)
+[![Tailwind CSS](https://img.shields.io/badge/TailwindCSS-3.4-blue?style=flat-square&logo=tailwind-css&logoColor=white)](https://tailwindcss.com/)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5-blue?style=flat-square&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
+[![Electron](https://img.shields.io/badge/Electron-28-47848F?style=flat-square&logo=electron&logoColor=white)](https://www.electronjs.org/)
+[![MIT License](https://img.shields.io/badge/License-MIT-green?style=flat-square)](LICENSE)

-## Features
+A modern, cross-platform blog system built with **Next.js**, **Markdown**, and **Electron**. Write posts in Markdown, manage content visually, and deploy to web or desktop.

- Write blog posts in Markdown
- Responsive web design
- Desktop application support via Electron
- Mobile-friendly interface
- Tag-based organization
- Clean and modern UI
+---

-## Getting Started
+## ✨ Features
+
+- ✍️ **Markdown-based posts** — Write and organize content in Markdown files
+- ⚡ **Hot reloading** — See changes instantly as you edit posts
+- 🗂️ **Folder & tag organization** — Structure your content with folders and tags
+- 🖥️ **Electron desktop app** — Run your blog as a native desktop app
+- 📱 **Responsive UI** — Mobile-friendly and clean design
+- 🛠️ **Admin dashboard** — Manage posts and folders visually
+
+---
+
+## 🚀 Getting Started

 ### Prerequisites

- Node.js 18+ and npm
+- [Node.js 18+](https://nodejs.org/)
+- [npm](https://www.npmjs.com/)

 ### Installation

-1. Clone the repository:
 ```bash
-git clone <repository-url>
+git clone 
 cd markdownblog
-```
-
-2. Install dependencies:
-```bash
 npm install
 ```

-3. Start the development server:
-```bash
-npm run dev
-```
+### Development

-4. For desktop development:
-```bash
-npm run electron-dev
-```
+- **Web:**  
+  `npm run dev`
+- **Desktop (Electron):**  
+  `npm run electron-dev`

-### Writing Posts
+### Production

-Create new blog posts by adding Markdown files to the `posts/` directory. Each post should include frontmatter with the following fields:
+- **Web build:**  
+  `npm run build`
+- **Desktop build:**  
+  `npm run electron-build`
+
+---
+
+## 📝 Writing Posts
+
+Add Markdown files to the `posts/` directory. Each post should have frontmatter:

 ```markdown
 ---
@@ -55,39 +67,47 @@ summary: "A brief summary of your post"
 Your post content here...
 ```

-### Building for Production
+---

-1. Build the web version:
-```bash
-npm run build
-```
-
-2. Build the desktop version:
-```bash
-npm run electron-build
-```
-
-## Project Structure
+## 🗂️ Project Structure

 ```
 markdownblog/
 ├── posts/           # Markdown blog posts
 ├── src/
-│   ├── app/        # Next.js app directory
-│   └── lib/        # Utility functions
-├── electron/       # Desktop app code
-└── public/         # Static assets
+│   ├── app/         # Next.js app directory
+│   └── lib/         # Utility functions
+├── electron/        # Desktop app code
+├── public/          # Static assets (favicons, etc.)
+└── ...
 ```

-## Technologies Used
+---

- Next.js 14
- TypeScript
- Tailwind CSS
- Electron
- Markdown (remark)
- date-fns
+## 🌐 Favicon

-## License
+Place your favicon files (e.g., `favicon.ico`, `favicon-32x32.png`, `favicon-16x16.png`) in the `public` directory at the project root.  
+Next.js will automatically serve these at the root URL (e.g., `/favicon.ico`).
+
+---
+
+## 🛠️ Technologies Used
+
+- [Next.js 14](https://nextjs.org/)
+- [TypeScript](https://www.typescriptlang.org/)
+- [Tailwind CSS](https://tailwindcss.com/)
+- [Electron](https://www.electronjs.org/)
+- [Remark](https://remark.js.org/) (Markdown)
+- [date-fns](https://date-fns.org/)
+
+---
+
+## 🐳 Docker
+
+A sample `Dockerfile` and `manage_container.sh` are included for containerized deployment.
+
+---
+
+## 📄 License

 MIT