修改README

This commit is contained in:
eoao
2026-01-02 23:09:00 +08:00
parent 6f83a440dc
commit 693e3aa9f1
2 changed files with 66 additions and 30 deletions

View File

@@ -1,21 +1,40 @@
<p align="center">
<img src="doc/demo/logo.png" width="80px" />
<img src="doc/demo/logo.png" width="80px" />
<h1 align="center">Cloud Mail</h1>
<p align="center">A simple, responsive email service designed to run on Cloudflare Workers 🎉</p>
<p align="center">
<a href="/README.md" style="margin-left: 5px">简体中文</a> | English
</p>
<p align="center">
<a href="https://github.com/maillab/cloud-mail/tree/main?tab=MIT-1-ov-file" target="_blank" >
<img src="https://img.shields.io/badge/license-MIT-green" />
</a>
<a href="https://github.com/maillab/cloud-mail/releases" target="_blank" >
<img src="https://img.shields.io/github/v/release/maillab/cloud-mail" alt="releases" />
</a>
<a href="https://github.com/maillab/cloud-mail/issues" >
<img src="https://img.shields.io/github/issues/maillab/cloud-mail" alt="issues" />
</a>
<a href="https://github.com/maillab/cloud-mail/stargazers" target="_blank">
<img src="https://img.shields.io/github/stars/maillab/cloud-mail" alt="stargazers" />
</a>
<a href="https://github.com/maillab/cloud-mail/forks" target="_blank" >
<img src="https://img.shields.io/github/forks/maillab/cloud-mail" alt="forks" />
</a>
</p>
<p align="center">
<a href="https://trendshift.io/repositories/14418" target="_blank" >
<img src="https://trendshift.io/api/badge/repositories/14418" alt="trendshift" >
</a>
</p>
</p>
<div align="center">
<h1>Cloud Mail</h1>
</div>
<div align="center">
<h4>A minimalist, responsive email service for sending emails, deployable on Cloudflare 🎉</h4>
</div>
## Description
With only one domain, you can create multiple different email addresses, similar to major email platforms. This project can be deployed on Cloudflare Workers to reduce server costs and build your own email service.
## Project Showcase
- [Online Demo](https://skymail.ink)<br>
- [Live Demo](https://skymail.ink)<br>
- [Deployment Guide](https://doc.skymail.ink/en/)<br>
- [UI Deployment](https://doc.skymail.ink/en/guide/via-ui.html)
| ![](/doc/demo/demo1.png) | ![](/doc/demo/demo2.png) |
@@ -28,9 +47,9 @@
- **💻 Responsive Design**: Automatically adapts to both desktop and most mobile browsers.
- **📧 Email Sending**: Integrated with Resend for bulk email sending, embedded images, attachments, and status tracking.
- **📧 Email Sending**: Integrated with Resend, supporting bulk email sending and attachments.
- **🛡️ Admin Features**: Admins can manage users and emails, with RBAC permission control to limit access to features and resources.
- **🛡️ Admin Features**: Admin controls for user and email management with RBAC-based access control.
- **📦 Attachment Support**: Send and receive attachments, stored and downloaded via R2 object storage.
@@ -38,7 +57,7 @@
- **📡 Open API**: Supports batch user creation via API and multi-condition email queries
- **📈 Data Visualization**: Use Echarts to visualize system data, including user email growth.
- **📈 Data Visualization**: Use ECharts to visualize system data, including user email growth.
- **🎨 Personalization**: Customize website title, login background, and transparency.
@@ -48,7 +67,7 @@
## Tech Stack
- **Serverless**: [Cloudflare Workers](https://developers.cloudflare.com/workers/)
- **Platform**: [Cloudflare Workers](https://developers.cloudflare.com/workers/)
- **Web Framework**: [Hono](https://hono.dev/)
@@ -66,7 +85,7 @@
- **File Storage**: [Cloudflare R2](https://developers.cloudflare.com/r2/)
## 目录结构
## Project Structure
```
cloud-mail