From 455665a16bd368cff873a8b9ef21ff0d77d7f715 Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 23 Oct 2025 22:25:54 +0800 Subject: [PATCH] docs: enhance README with improved feature descriptions and formatting --- README.md | 51 ++++++++++++++++----------------------------------- 1 file changed, 16 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 076e2878b..d46bc2028 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Write, organize, and own your knowledge Warp - The terminal for the 21st century -**[Warp](https://go.warp.dev/memos)** — The AI-powered terminal built for speed and collaboration +[**Warp** — The AI-powered terminal built for speed and collaboration](https://go.warp.dev/memos) ![screenshot](https://raw.githubusercontent.com/usememos/.github/refs/heads/main/assets/demo.png) @@ -42,6 +42,7 @@ Memos is an open-source, self-hosted alternative to cloud note-taking services. ## 🚀 Quick Start Get up and running in **under 30 seconds**: + ```bash docker run -d \ --name memos \ @@ -56,40 +57,19 @@ Open `http://localhost:5230` and start writing! 🎉 ## ✨ Features - - - - - -
+- **🔒 Privacy-First Architecture** — Self-hosted on your infrastructure with no telemetry or tracking. Your data stays yours with full ownership and export capabilities. -### 🔐 Privacy First -- Self-hosted on your infrastructure -- No telemetry or tracking -- Full data ownership -- Export anytime +- **⚡ Lightning-Fast Performance** — Built with Go and React for exceptional speed. Real-time updates ensure your notes are always in sync across devices. -### 📱 Modern Experience -- Clean, intuitive interface -- Mobile-responsive design -- Real-time updates -- Dark mode support +- **📝 Markdown Native** — Write naturally with full markdown support, code highlighting, and rich text rendering. No lock-in, just plain text you can take anywhere. - +- **🐳 Deploy in Seconds** — One Docker command to get started. Simple deployment with Docker Compose, binaries, or Kubernetes. -### 🛠️ Developer Friendly -- RESTful API -- SQLite, PostgreSQL, MySQL support -- Easy to deploy and scale -- Extensive documentation +- **🎨 Beautiful & Minimal UI** — Clean, intuitive interface that stays out of your way. Mobile-responsive design with dark mode support. -### 🌍 Open Source -- MIT licensed -- Active community -- Regular updates -- Transparent development +- **🔗 Powerful API** — RESTful and gRPC APIs for seamless integration with your existing workflow. Build custom tools and automations easily. -
+- **🌍 Open Source & Community-Driven** — MIT licensed with an active community. Regular updates and transparent development on GitHub. ## 💡 Perfect For @@ -114,13 +94,14 @@ Love Memos? Help us keep it growing! fixermark alik-agaev -*Every contribution, big or small, makes a difference!* +_Every contribution, big or small, makes a difference!_ ## 🤝 Contributing We love contributions! Whether you're fixing bugs, adding features, improving docs, or spreading the word — every contribution matters. **Get involved:** + - 🐛 [Report bugs](https://github.com/usememos/memos/issues/new?template=bug_report.md) - 💡 [Suggest features](https://github.com/usememos/memos/issues/new?template=feature_request.md) - 🔧 [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
-**[Website](https://www.usememos.com)** • -**[Documentation](https://www.usememos.com/docs)** • -**[Demo](https://demo.usememos.com/)** • -**[Discord](https://discord.gg/tfPJa4UmAv)** • -**[Twitter](https://twitter.com/usememos)** +**[Website](https://www.usememos.com)** • +**[Docs](https://www.usememos.com/docs)** • +**[Demo](https://demo.usememos.com/)** • +**[X](https://x.com/usememos)** • +**[Discord](https://discord.gg/tfPJa4UmAv)** Made with ❤️ by the Memos community