blossom/README-EN.md
2024-01-08 00:40:47 +08:00

148 lines
5.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<p align="center">
<img src="./doc/imgs/blossom_name.png" height="auto">
</p>
<p align="center">
<a href="https://www.wangyunf.com/blossom-demo/#/settingindex">💻️ Demo</a> | <a href="https://www.wangyunf.com/blossom-doc/index.html">📃 Document</a> | <a href="https://www.wangyunf.com/blossom-doc/guide/about/download.html">📥 Download</a>
</p>
Blossom is a note-taking software which support **self-hosted** and **cloud-based dual-chain storing**You can store your notes, images, and personal schedules on your own server and synchronize them in real-time across any device. It also functions as a dynamic blog。
It can running on WindowsMacweb-based clients, and mobile web interfaces.
<p align="center">
<img src="./doc/imgs/device.png">
</p>
# 🛎️ Trial
You can try it out through the [This](https://www.wangyunf.com/blossom-demo/#/settingindex) or [Download the client](https://www.wangyunf.com/blossom-doc/guide/about/download.html) , for more details , please refer to the [trial](https://www.wangyunf.com/blossom-doc/guide/tryuse.html) documentation。
<br/><br/>
# 👏 Blossom Feature:
### Complete & Self-Contained
Blossom doesn't rely on any third-party storage or image hosting; it functions as its own image hosting service. It offers comprehensive image management, anti-deletion measures, and establishes bidirectional relationships between images and articles.
You can write in Markdown with non-destructive syntax extensions, content created here can be displayed correctly in any Markdown software.
### Quick Migration
All images and articles support one-click backup and export, making migration easy within minutes. The exported files can seamlessly be opened with local software like VS Code or Obsidian.
### Additional Features
- 📅 [Schedule](https://www.wangyunf.com/blossom-doc/guide/plan.html)
- 🏷️ [To-Do](https://www.wangyunf.com/blossom-doc/guide/todo.html)
- 🎫 [QuickNote](https://www.wangyunf.com/blossom-doc/guide/note.html)
- 🍅 [Pomodoro Timer](https://www.wangyunf.com/blossom-doc/guide/article.html#tomato)
- 🧰 Multi-user support, word count statistics, word count trend chart, editing heatmap, weather forecast, theme settings, and more...
Blossom boasts a wealth of features, serving not only as a knowledge management tool but also as a comprehensive and practical utility for simultaneous multi-user usage.
<br/><br/>
# 🚀 Docker Compose in One Click
```
docker compose -f docker/compose/blossom-mysql8.yaml up -d
```
<br/><br/>
# 🥳 Contact
Join QQ group, communicate with us and discuss problems.
- Group 1522359970 (It is full)
- Group 2921906098
You can also contact with us by the issue , We will definitely try our best to reply to you.
We also welcome everyone to participate in the development and discussion of Blossom.
<p align="center">
<img src="./doc/imgs/qq1.png" height="400">
<img src="./doc/imgs/qq2.png" height="400">
</p>
# 🤝 Sponsor Blossom
**Blossom No charges will be applied ; you can use it permanently for free!**
However, sustaining a livelihood through open-source software is challenging. The project's design, development, and testing demand considerable time and effort. If you're willing to sponsor my work, it would significantly contribute to the project's growth and motivate me to continue long-term.
**Thanks to every sponsor for their strong support, Blossom becomes better because of all of you.**
| Sponsors | Sponsors | Sponsors | Sponsors |
| :------------------- | :------------ | :------------ | :--------------- |
| i just walked away🏃 | KalyanYang | dsx | 熊猫不是猫 |
| 白驹过隙 | Alipay-\*发 | Alipay-\*琛 | Alipay Anonymous |
| 疾风剑豪索隆 | 放羊的星星 | 立冬 | 给你一支烟 |
| 林诗 | Criesgod | Alipay-\*伟 | 黑醋栗和丁香 |
| Mr_tg000 | Lucky | egil | Glimpse |
| Alipay-\*\*衡 | Alipay-\*\*福 | Alipay-\*\*盼 | 何其正 |
| -A 明 | 开心。 | Please | 樹梢 |
| Alipay-\*\*耀 | Crius | 初五 | 一巷灯火深 |
| Alipay-\*\*鲲 | 木辰音 | 宁采臣 | Alipay-\*\*雷 |
---
<h4 align="center">You can sponsor Blossom in the following way. </h4>
<p align="center">
<img src="./doc/imgs/sponsors/wechat.png" height="400">
<img src="./doc/imgs/sponsors/ali.png" height="400">
<img src="./doc/imgs/sponsors/aifadian.png" height="400">
</p>
<br/>
# More
!["Editor"](./doc/imgs/article.png)
<p align="center">Editor</p>
---
!["Dual-chain Notes"](./doc/imgs/article_reference.png)
<p align="center">Dual-chain Notes</p>
---
!["Gallery"](./doc/imgs/picture.png)
<p align="center">Gallery</p>
---
!["To-Do"](./doc/imgs/todo.png)
<p align="center">To-Do</p>
---
!["Schedule"](./doc/imgs/plan.png)
<p align="center">Schedule</p>
---
!["Note"](./doc/imgs/note.png)
<p align="center">Notes</p>
---
!["Blog"](./doc/imgs/blog_home_pc.png)
<p align="center">Blog</p>
<p align="center">
<img src="./doc/imgs/blog_home_m.png" height="600">
<img src="./doc/imgs/blog_article.png" height="600" style="margin-left: 30px">
</p>
<p align="center">Mobile Blog</p>