Skip to content

Commit f6817af

Browse files
committed
docs: update readme
1 parent 4b90344 commit f6817af

2 files changed

Lines changed: 113 additions & 83 deletions

File tree

README.md

Lines changed: 49 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,71 @@
1+
# English Version
2+
13
# Rin
24

35
English | [简体中文](./README_zh_CN.md)
46

57
![Cover](./docs/docs/public/rin-logo.png)
68

7-
![GitHub commit activity](https://img.shields.io/github/commit-activity/w/openRin/Rin?style=for-the-badge)
8-
![GitHub branch check runs](https://img.shields.io/github/check-runs/openRin/Rin/main?style=for-the-badge)
9-
![GitHub top language](https://img.shields.io/github/languages/top/openRin/Rin?style=for-the-badge)
10-
![GitHub License](https://img.shields.io/github/license/openRin/Rin?style=for-the-badge)
11-
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/openRin/Rin/deploy.yaml?style=for-the-badge)
9+
!https://img.shields.io/github/commit-activity/w/openRin/Rin?style=for-the-badge
10+
!https://img.shields.io/github/check-runs/openRin/Rin/main?style=for-the-badge
11+
!https://img.shields.io/github/languages/top/openRin/Rin?style=for-the-badge
12+
!https://img.shields.io/github/license/openRin/Rin?style=for-the-badge
13+
!https://img.shields.io/github/actions/workflow/status/openRin/Rin/deploy.yaml?style=for-the-badge
1214

13-
[![Discord](https://img.shields.io/badge/Discord-openRin-red?style=for-the-badge&color=%236e7acc)](https://discord.gg/JWbSTHvAPN)
14-
[![Telegram](https://img.shields.io/badge/Telegram-openRin-red?style=for-the-badge&color=%233390EC)](https://t.me/openRin)
15+
https://img.shields.io/badge/Discord-openRin-red?style=for-the-badge&color=%236e7acc](https://discord.gg/JWbSTHvAPN)
16+
https://img.shields.io/badge/Telegram-openRin-red?style=for-the-badge&color=%233390EC](https://t.me/openRin)
1517

16-
# Introduction
18+
## Introduction
1719

18-
Rin is a blog based on Cloudflare Pages + Workers + D1 + R2. It does not require a server to deploy. It can be deployed just with a domain name that resolves to Cloudflare.
20+
Rin is a modern, serverless blog platform built entirely on Cloudflare's developer platform: Pages for hosting, Workers for serverless functions, D1 for SQLite database, and R2 for object storage. Deploy your personal blog with just a domain name pointed to Cloudflare—no server management required.
1921

20-
## Demo
22+
## Live Demo
2123

22-
[xeu.life](https://xeu.life)
24+
https://xeu.life
2325

2426
## Features
25-
1. Support GitHub OAuth login. By default, the first logged-in user has management privileges, and other users are ordinary users
26-
2. Support article writing and editing
27-
3. Support local real-time saving of modifications/edits to any article without interfering between multiple articles
28-
4. Support setting it as visible only to yourself, which can serve as a draft box for cloud synchronization or record more private content
29-
5. Support dragging/pasting uploaded images to a bucket that supports the S3 protocol and generating links
30-
6. Support setting article aliases, and access articles through links such as https://xeu.life/about
31-
7. Support articles not being listed in the homepage list
32-
8. Support adding links of friends' blog, and the backend regularly checks and updates the accessible status of links every 20 minutes
33-
9. Support replying to comment articles/deleting comments
34-
10. Support sending comment notifications through Webhook
35-
11. Support automatic identification of the first picture in the article and display it as the header image in the article list
36-
12. Support inputting tag texts such as "#Blog #Cloudflare" and automatically parsing them into tags
37-
13. For more features, please refer to https://xeu.life
38-
39-
# Documentation
40-
41-
## 快速开始
27+
- **Authentication & Management**: GitHub OAuth login. The first registered user becomes an administrator, while subsequent users join as regular members.
28+
- **Content Creation**: Write and edit articles with a rich, intuitive editor.
29+
- **Real-time Autosave**: Local drafts are saved automatically in real-time, with isolation between different articles.
30+
- **Privacy Control**: Mark articles as "Visible only to me" for private drafts or personal notes, synchronized across devices.
31+
- **Image Management**: Drag-and-drop or paste images to upload directly to S3-compatible storage (e.g., Cloudflare R2), with automatic link generation.
32+
- **Custom Slugs**: Assign friendly URLs like `https://yourblog.com/about` using custom article aliases.
33+
- **Unlisted Posts**: Option to keep articles out of the public homepage listing.
34+
- **Blogroll**: Add links to friends' blogs. The backend automatically checks link availability every 20 minutes.
35+
- **Comment System**: Reply to comments or moderate them with delete functionality.
36+
- **Webhook Notifications**: Receive real-time alerts for new comments via configurable webhooks.
37+
- **Featured Images**: Automatically detect the first image in an article and use it as the cover image in listings.
38+
- **Tag Parsing**: Input tags like `#Blog #Cloudflare` and have them automatically parsed and displayed.
39+
- ...and more! Explore all features at https://xeu.life.
40+
41+
## Documentation
42+
43+
### Quick Start
4244

4345
```bash
44-
# 1. 克隆项目
46+
# 1. Clone the repository
4547
git clone https://github.com/openRin/Rin.git && cd Rin
4648

47-
# 2. 安装依赖
49+
# 2. Install dependencies
4850
bun install
4951

50-
# 3. 配置环境变量
52+
# 3. Configure environment variables
5153
cp .env.example .env.local
52-
# 编辑 .env.local 填入你的配置
54+
# Edit .env.local with your own configuration
5355

54-
# 4. 启动开发服务器
56+
# 4. Start the development server
5557
bun run dev
5658
```
5759

58-
访问 http://localhost:5173 开始开发!
60+
Visit http://localhost:5173 to start hacking!
61+
62+
Full documentation is available at https://docs.openrin.org.
63+
64+
## Community & Support
5965

60-
详细文档:[docs.openrin.org](https://docs.openrin.org)
66+
- Join our https://discord.gg/JWbSTHvAPN for discussions and help.
67+
- Follow updates on https://t.me/openRin.
68+
- Found a bug or have a feature request? Please open an issue on GitHub.
6169

6270
## Star History
6371

@@ -69,7 +77,12 @@ bun run dev
6977
</picture>
7078
</a>
7179

72-
# License
80+
## Contributing
81+
82+
We welcome contributions of all kinds—code, documentation, design, and ideas. Please check out our [contributing guidelines](https://docs.openrin.org/en/guide/contribution.html) and join us in building Rin together!
83+
84+
## License
85+
7386
```
7487
MIT License
7588

README_zh_CN.md

Lines changed: 64 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,92 @@
1-
# Rin
21

3-
[English](./README.md) | 简体中文
42

53

64
![封面](./docs/docs/public/rin-logo.png)
75

6+
[English](./README.md) | 简体中文
7+
88
![GitHub commit activity](https://img.shields.io/github/commit-activity/w/openRin/Rin?style=for-the-badge)
99
![GitHub branch check runs](https://img.shields.io/github/check-runs/openRin/Rin/main?style=for-the-badge)
1010
![GitHub top language](https://img.shields.io/github/languages/top/openRin/Rin?style=for-the-badge)
1111
![GitHub License](https://img.shields.io/github/license/openRin/Rin?style=for-the-badge)
1212
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/openRin/Rin/deploy.yaml?style=for-the-badge)
1313

14-
# 介绍
14+
## 项目简介
15+
16+
Rin 是一个基于 Cloudflare 开发者平台构建的现代化、无服务器博客系统,完全利用 Cloudflare Pages 托管、Workers 提供无服务器函数、D1 作为 SQLite 数据库、R2 进行对象存储。仅需一个指向 Cloudflare 的域名即可部署你的个人博客,无需服务器运维。
17+
18+
## 在线演示
1519

16-
Rin 是一个基于 Cloudflare Pages + Workers + D1 + R2 全家桶的博客,无需服务器无需备案,只需要一个解析到 Cloudflare 的域名即可部署。
20+
https://xeu.life
1721

18-
## 演示地址
22+
## 功能特性
23+
- **用户认证与管理**:支持 GitHub OAuth 登录。首个注册用户自动成为管理员,后续用户作为普通成员加入。
24+
- **内容创作**:通过丰富的编辑器撰写和编辑文章。
25+
- **实时自动保存**:本地草稿实时自动保存,不同文章之间互不干扰。
26+
- **隐私控制**:可将文章标记为“仅自己可见”,用作私有草稿或个人笔记,并支持跨设备同步。
27+
- **图片管理**:通过拖放或粘贴上传图片至兼容 S3 的存储(如 Cloudflare R2),并自动生成链接。
28+
- **自定义别名**:为文章设置友好的 URL,例如 `https://yourblog.com/about`
29+
- **不公开文章**:可选择将文章隐藏于首页列表之外。
30+
- **友情链接**:添加友博客链接,后端每 20 分钟自动检查链接可用性并更新状态。
31+
- **评论系统**:支持回复评论,并具备评论删除管理功能。
32+
- **Webhook 通知**:通过可配置的 Webhook 接收新评论的实时提醒。
33+
- **特色图片**:自动识别文章内首张图片,并将其作为列表页的封面图展示。
34+
- **标签解析**:输入如 `#博客 #Cloudflare` 的标签文本,自动解析并展示为标签。
35+
- ……更多功能请访问 https://xeu.life 探索。
1936

20-
[xeu.life](https://xeu.life)
37+
## 文档
2138

39+
### 快速开始
40+
41+
```bash
42+
# 1. 克隆仓库
43+
git clone https://github.com/openRin/Rin.git && cd Rin
44+
45+
# 2. 安装依赖
46+
bun install
47+
48+
# 3. 配置环境变量
49+
cp .env.example .env.local
50+
# 编辑 .env.local 填入你的配置信息
51+
52+
# 4. 启动开发服务器
53+
bun run dev
54+
```
2255

23-
## 特性
24-
1. 支持 Github OAuth 登录,默认第一个登录的用户拥有管理权限,其他用户均为普通用户
25-
2. 支持文章的写作与编辑
26-
3. 支持本地实时保存对任意文章的修改/编辑且多篇文章互不干扰
27-
4. 支持设置为仅自己可见,可以充当云端同步的草稿箱或者记录隐私性较强的内容
28-
5. 支持拖拽/粘贴上传图片到支持 S3 协议的存储桶并生成链接
29-
6. 支持设置文章别名,可通过形如 https://xeu.life/about 链接访问文章
30-
7. 支持文章不列出在首页列表中
31-
8. 支持添加友链,同时后端每间隔 20 分钟定期检查更新友链可访问状态
32-
9. 支持回复评论文章/删除评论
33-
10. 支持通过 Webhook 发送评论通知
34-
11. 支持自动识别文章中的第一张图片并作为头图展示在文章列表中
35-
12. 支持输入形如"#博客 #部署 #Cloudflare"之类的标签文本并自动解析为标签
36-
13. 更多特性请参考 https://xeu.life
56+
访问 http://localhost:5173 开始开发!
3757

38-
# 文档
58+
完整文档请访问 https://docs.openrin.org。
3959

40-
[docs.openrin.org](https://docs.openrin.org)
60+
## 社区与支持
4161

42-
## Star History
62+
- 加入我们的 https://discord.gg/JWbSTHvAPN 参与讨论或获取帮助。
63+
- 关注 https://t.me/openRin 频道获取最新动态。
64+
- 发现 Bug 或有功能建议?欢迎在 GitHub 上提交 Issue。
65+
66+
## Star 历史
4367

4468
<a href="https://star-history.com/#openRin/Rin&Date">
4569
<picture>
4670
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=openRin/Rin&type=Date&theme=dark" />
4771
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=openRin/Rin&type=Date" />
48-
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=openRin/Rin&type=Date" />
72+
<img alt="Star 历史图表" src="https://api.star-history.com/svg?repos=openRin/Rin&type=Date" />
4973
</picture>
5074
</a>
5175

52-
# License
53-
```
54-
MIT License
55-
56-
Copyright (c) 2024 Xeu
57-
58-
Permission is hereby granted, free of charge, to any person obtaining a copy
59-
of this software and associated documentation files (the "Software"), to deal
60-
in the Software without restriction, including without limitation the rights
61-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
62-
copies of the Software, and to permit persons to whom the Software is
63-
furnished to do so, subject to the following conditions:
64-
65-
The above copyright notice and this permission notice shall be included in all
66-
copies or substantial portions of the Software.
67-
68-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
69-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
70-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
71-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
72-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
73-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
74-
SOFTWARE.
76+
## 参与贡献
77+
78+
我们欢迎各种形式的贡献——代码、文档、设计和想法。请查阅我们的贡献指南(即将添加),一起参与 Rin 的构建!
79+
80+
## 开源许可证
81+
7582
```
83+
MIT 许可证
84+
85+
版权所有 (c) 2024 Xeu
86+
87+
特此免费授予任何获得本软件及相关文档文件(“软件”)副本的人不受限制地处理本软件的权限,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售本软件副本的权利,并允许向其提供本软件的人员这样做,但须符合以下条件:
88+
89+
上述版权声明和本许可声明应包含在本软件的所有副本或主要部分中。
90+
91+
本软件按“原样”提供,不附带任何明示或暗示的担保,包括但不限于对适销性、特定用途适用性和非侵权的担保。在任何情况下,作者或版权持有人均不对因本软件或使用本软件或其他交易行为而引起的任何索赔、损害赔偿或其他责任承担责任,无论是在合同诉讼、侵权行为还是其他诉讼中。
92+
```

0 commit comments

Comments
 (0)