happyz
/
memos
mirror of https://github.com/usememos/memos.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore: update README for clarity and consistency

This commit is contained in:
Steven 2025-10-28 07:46:45 +08:00
parent d516f9aab2
commit 2197178dd7
1 changed files with 54 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

124
README.md
View File

@ -2,7 +2,7 @@
<img align="right" height="96px" src="https://raw.githubusercontent.com/usememos/.github/refs/heads/main/assets/logo-rounded.png" alt="Memos" />
An open-source, self-hosted note-taking services. Write, organize, and own your notes. No tracking, no ads, no subscription fees — just a clean, fast way to capture your ideas.
An open-source, self-hosted note-taking service. Your thoughts, your data, your control — no tracking, no ads, no subscription fees.
[![Home](https://img.shields.io/badge/🏠-usememos.com-blue?style=flat-square)](https://www.usememos.com)
[![Live Demo](https://img.shields.io/badge/✨-Try%20Demo-orange?style=flat-square)](https://demo.usememos.com/)
@ -20,13 +20,11 @@ An open-source, self-hosted note-taking services. Write, organize, and own your
<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="300" />
</a>
## 🎯 Why Memos?
## Overview
**Your thoughts. Your data. Your control.**
Memos is a privacy-first, self-hosted knowledge base that works seamlessly for personal notes, team wikis, and knowledge management. Built with Go and React, it offers lightning-fast performance without compromising on features or usability.
Memos is an open-source, self-hosted alternative to cloud note-taking services. No tracking, no ads, no subscription fees — just a clean, fast way to capture and organize your ideas.
### 🆚 What Makes Memos Different?
**Why choose Memos over cloud services?**
| Feature | Memos | Cloud Services |
| ----------------- | ------------------------------ | ----------------------------- |
@ -36,38 +34,42 @@ Memos is an open-source, self-hosted alternative to cloud note-taking services.
| **Ownership** | ✅ Full control & export | ❌ Vendor lock-in |
| **API Access** | ✅ Full REST + gRPC APIs | ⚠️ Limited or paid |
| **Customization** | ✅ Open source, forkable | ❌ Closed ecosystem |
| **Deployment** | ✅ Single binary, Docker | ⚠️ SaaS only |
## ✨ Features
## 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 Architecture**
- **⚡ Lightning-Fast Performance** — Built with Go and React for exceptional speed. Real-time updates ensure your notes are always in sync across devices.
- Self-hosted on your infrastructure with zero telemetry
- Complete data ownership and export capabilities
- No tracking, no ads, no vendor lock-in
- **📝 Markdown Native** — Write naturally with full markdown support, code highlighting, and rich text rendering. No lock-in, just plain text you can take anywhere.
- **📝 Markdown Native**
- **🐳 Deploy in Seconds** — One Docker command to get started. Simple deployment with Docker Compose, binaries, or Kubernetes.
- Full markdown support
- Plain text storage — take your data anywhere
- **🎨 Beautiful & Minimal UI** — Clean, intuitive interface that stays out of your way. Mobile-responsive design with dark mode support.
- **⚡ Blazing Fast**
- **🔗 Powerful API** — RESTful and gRPC APIs for seamless integration with your existing workflow. Build custom tools and automations easily.
- Built with Go backend and React frontend
- Optimized for performance at any scale
- **🌍 Open Source & Community-Driven** — MIT licensed with an active community. Regular updates and transparent development on GitHub.
- **🐳 Simple Deployment**
## 💡 Perfect For
- One-line Docker installation
- Supports SQLite, MySQL, and PostgreSQL
- 📓 **Personal Journaling** — Capture daily thoughts, reflections, and life moments in a private space
- 🧠 **Knowledge Management** — Build your second brain with interconnected notes and tags
- 📋 **Quick Captures** — Instantly jot down ideas before they vanish
- 💻 **Developer Notes** — Store code snippets, commands, and technical references with syntax highlighting
- 🔗 **Link Collections** — Bookmark and organize articles, resources, and inspiration
- 👥 **Team Wikis** — Share knowledge across your team with collaborative docs
- 🎓 **Learning Logs** — Track your learning journey, courses, and new skills
- 📝 **Meeting Notes** — Keep all your meeting agendas and action items organized
- **🔗 Developer-Friendly**
## 🚀 Quick Start
- Full REST and gRPC APIs
- Easy integration with existing workflows
Get up and running in **under 30 seconds**:
- **🎨 Beautiful Interface**
- Clean, minimal design and dark mode support
- Mobile-responsive layout
## Quick Start
### Docker (Recommended)
```bash
docker run -d \
@ -77,47 +79,26 @@ docker run -d \
neosmemo/memos:stable
```
Open `http://localhost:5230` and start writing! 🎉
Open `http://localhost:5230` and start writing!
### 🎮 Try the Live Demo
### Try the Live Demo
Don't want to install yet? Try our [live demo](https://demo.usememos.com/) first!
**Demo Credentials:**
### Other Installation Methods
- Username: `demo`
- Password: `secret`
- **Docker Compose** - Recommended for production deployments
- **Pre-built Binaries** - Available for Linux, macOS, and Windows
- **Kubernetes** - Helm charts and manifests available
- **Build from Source** - For development and customization
### 📦 More Deployment Options
See our [installation guide](https://www.usememos.com/docs/installation) for detailed instructions.
**Need more options?** Check out our [installation guide](https://www.usememos.com/docs/installation) for:
## Contributing
- Docker Compose (recommended for production)
- Pre-built binaries (Linux, macOS, Windows)
- Kubernetes deployments
- Building from source
We welcome contributions of all kinds! Whether you're fixing bugs, adding features, improving documentation, or helping with translations — every contribution matters.
## 💖 Support Memos
Love Memos? Help us keep it growing!
<a href="https://github.com/sponsors/usememos" target="_blank">
<img src="https://img.shields.io/badge/❤️_Sponsor_on_GitHub-ea4aaa?style=for-the-badge&logo=github-sponsors&logoColor=white" alt="Sponsor on GitHub">
</a>
**Community Sponsors:**
<a href="https://github.com/yourselfhosted" target="_blank"><img src="https://avatars.githubusercontent.com/u/140182318?v=4" alt="yourselfhosted" height="50" style="border-radius: 50%; margin: 5px;" /></a>
<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>
<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>
_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:**
**Ways to contribute:**
- 🐛 [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)
@ -125,22 +106,25 @@ We love contributions! Whether you're fixing bugs, adding features, improving do
- 📖 [Improve documentation](https://github.com/usememos/memos/tree/main/docs)
- 🌍 [Help with translations](https://github.com/usememos/memos/tree/main/web/src/locales)
## ⭐ Star History
## Sponsors
Love Memos? [Sponsor us on GitHub](https://github.com/sponsors/usememos) to help keep the project growing!
**Featured Supportors:**
<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>
<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>
## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=usememos/memos&type=Date)](https://star-history.com/#usememos/memos&Date)
## License
Memos is open-source software licensed under the [MIT License](LICENSE).
---
<div align="center">
**[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)**
**[Website](https://www.usememos.com)** • **[Documentation](https://www.usememos.com/docs)** • **[Demo](https://demo.usememos.com/)** • **[Discord](https://discord.gg/tfPJa4UmAv)** • **[X/Twitter](https://x.com/usememos)**
Made with ❤️ by the Memos community
**If you like Memos, give us a ⭐ on GitHub!**
</div>