Skip to content

Commit 455665a

Browse files
committed
docs: enhance README with improved feature descriptions and formatting
1 parent f2f2a51 commit 455665a

File tree

1 file changed

+22
-41
lines changed

1 file changed

+22
-41
lines changed

README.md

Lines changed: 22 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Write, organize, and own your knowledge
2020
<img src="https://raw.githubusercontent.com/warpdotdev/brand-assets/main/Github/Sponsor/Warp-Github-LG-02.png" alt="Warp - The terminal for the 21st century" height="200" />
2121
</a>
2222

23-
**[Warp](https://go.warp.dev/memos)** — The AI-powered terminal built for speed and collaboration
23+
[**Warp** — The AI-powered terminal built for speed and collaboration](https://go.warp.dev/memos)
2424

2525
![screenshot](https://raw.githubusercontent.com/usememos/.github/refs/heads/main/assets/demo.png)
2626

@@ -42,6 +42,7 @@ Memos is an open-source, self-hosted alternative to cloud note-taking services.
4242
## 🚀 Quick Start
4343

4444
Get up and running in **under 30 seconds**:
45+
4546
```bash
4647
docker run -d \
4748
--name memos \
@@ -56,40 +57,19 @@ Open `http://localhost:5230` and start writing! 🎉
5657

5758
## ✨ Features
5859

59-
<table>
60-
<tr>
61-
<td width="50%">
62-
63-
### 🔐 Privacy First
64-
- Self-hosted on your infrastructure
65-
- No telemetry or tracking
66-
- Full data ownership
67-
- Export anytime
68-
69-
### 📱 Modern Experience
70-
- Clean, intuitive interface
71-
- Mobile-responsive design
72-
- Real-time updates
73-
- Dark mode support
74-
75-
</td>
76-
<td width="50%">
77-
78-
### 🛠️ Developer Friendly
79-
- RESTful API
80-
- SQLite, PostgreSQL, MySQL support
81-
- Easy to deploy and scale
82-
- Extensive documentation
83-
84-
### 🌍 Open Source
85-
- MIT licensed
86-
- Active community
87-
- Regular updates
88-
- Transparent development
89-
90-
</td>
91-
</tr>
92-
</table>
60+
- **🔒 Privacy-First Architecture** — Self-hosted on your infrastructure with no telemetry or tracking. Your data stays yours with full ownership and export capabilities.
61+
62+
- **⚡ Lightning-Fast Performance** — Built with Go and React for exceptional speed. Real-time updates ensure your notes are always in sync across devices.
63+
64+
- **📝 Markdown Native** — Write naturally with full markdown support, code highlighting, and rich text rendering. No lock-in, just plain text you can take anywhere.
65+
66+
- **🐳 Deploy in Seconds** — One Docker command to get started. Simple deployment with Docker Compose, binaries, or Kubernetes.
67+
68+
- **🎨 Beautiful & Minimal UI** — Clean, intuitive interface that stays out of your way. Mobile-responsive design with dark mode support.
69+
70+
- **🔗 Powerful API** — RESTful and gRPC APIs for seamless integration with your existing workflow. Build custom tools and automations easily.
71+
72+
- **🌍 Open Source & Community-Driven** — MIT licensed with an active community. Regular updates and transparent development on GitHub.
9373

9474
## 💡 Perfect For
9575

@@ -114,13 +94,14 @@ Love Memos? Help us keep it growing!
11494
<a href="https://github.com/fixermark" target="_blank"><img src="https://avatars.githubusercontent.com/u/169982?v=4" alt="fixermark" height="50" style="border-radius: 50%; margin: 5px;" /></a>
11595
<a href="https://github.com/alik-agaev" target="_blank"><img src="https://avatars.githubusercontent.com/u/2662697?v=4" alt="alik-agaev" height="50" style="border-radius: 50%; margin: 5px;" /></a>
11696

117-
*Every contribution, big or small, makes a difference!*
97+
_Every contribution, big or small, makes a difference!_
11898

11999
## 🤝 Contributing
120100

121101
We love contributions! Whether you're fixing bugs, adding features, improving docs, or spreading the word — every contribution matters.
122102

123103
**Get involved:**
104+
124105
- 🐛 [Report bugs](https://github.com/usememos/memos/issues/new?template=bug_report.md)
125106
- 💡 [Suggest features](https://github.com/usememos/memos/issues/new?template=feature_request.md)
126107
- 🔧 [Submit pull requests](https://github.com/usememos/memos/pulls)
@@ -135,11 +116,11 @@ We love contributions! Whether you're fixing bugs, adding features, improving do
135116

136117
<div align="center">
137118

138-
**[Website](https://www.usememos.com)**
139-
**[Documentation](https://www.usememos.com/docs)**
140-
**[Demo](https://demo.usememos.com/)**
141-
**[Discord](https://discord.gg/tfPJa4UmAv)**
142-
**[Twitter](https://twitter.com/usememos)**
119+
**[Website](https://www.usememos.com)**
120+
**[Docs](https://www.usememos.com/docs)**
121+
**[Demo](https://demo.usememos.com/)**
122+
**[X](https://x.com/usememos)**
123+
**[Discord](https://discord.gg/tfPJa4UmAv)**
143124

144125
Made with ❤️ by the Memos community
145126

0 commit comments

Comments
 (0)