mirror of https://github.com/usememos/memos.git
chore: tweak readme
Signed-off-by: boojack <stevenlgtm@gmail.com>
This commit is contained in:
boojack
GitHub
parent
47e2ace690
commit
f7d370dba1
66
README.md
66
README.md
|
|
@ -20,7 +20,7 @@ An open-source, self-hosted note-taking service. Your thoughts, your data, your
|
|||
<img src="https://raw.githubusercontent.com/warpdotdev/brand-assets/main/Github/Sponsor/Warp-Github-LG-02.png" alt="Warp - The AI-powered terminal built for speed and collaboration" width="512" />
|
||||
</a>
|
||||
|
||||
---
|
||||
<p></p>
|
||||
|
||||
[**TestMu AI** - The world’s first full-stack Agentic AI Quality Engineering platform](https://www.testmu.ai/?utm_source=memos&utm_medium=sponsor)
|
||||
|
||||
|
|
@ -33,55 +33,21 @@ An open-source, self-hosted note-taking service. Your thoughts, your data, your
|
|||
[**SSD Nodes** - Affordable VPS hosting for self-hosters](https://ssdnodes.com/?utm_source=memos&utm_medium=sponsor)
|
||||
|
||||
<a href="https://ssdnodes.com/?utm_source=memos&utm_medium=sponsor" target="_blank" rel="noopener">
|
||||
<img src="https://usememos.com/sponsors/ssd-nodes.svg" alt="SSD Nodes" height="64" />
|
||||
<img src="https://usememos.com/sponsors/ssd-nodes.svg" alt="SSD Nodes" height="72" />
|
||||
</a>
|
||||
|
||||
## Overview
|
||||
|
||||
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.
|
||||
|
||||
**Why choose Memos over cloud services?**
|
||||
|
||||
| Feature | Memos | Cloud Services |
|
||||
| ----------------- | ------------------------------ | ----------------------------- |
|
||||
| **Privacy** | ✅ Self-hosted, zero telemetry | ❌ Your data on their servers |
|
||||
| **Cost** | ✅ Free forever, MIT license | ❌ Subscription fees |
|
||||
| **Performance** | ✅ Instant load, no latency | ⚠️ Depends on internet |
|
||||
| **Ownership** | ✅ Full control & export | ❌ Vendor lock-in |
|
||||
| **API Access** | ✅ Full REST + gRPC APIs | ⚠️ Limited or paid |
|
||||
| **Customization** | ✅ Open source, forkable | ❌ Closed ecosystem |
|
||||
Memos is a privacy-first, self-hosted knowledge base for personal notes, team wikis, and knowledge management. Built with Go and React, it runs as a single binary with minimal resource usage.
|
||||
|
||||
## Features
|
||||
|
||||
- **🔒 Privacy-First Architecture**
|
||||
|
||||
- Self-hosted on your infrastructure with zero telemetry
|
||||
- Complete data ownership and export capabilities
|
||||
- No tracking, no ads, no vendor lock-in
|
||||
|
||||
- **📝 Markdown Native**
|
||||
|
||||
- Full markdown support
|
||||
- Plain text storage — take your data anywhere
|
||||
|
||||
- **⚡ Blazing Fast**
|
||||
|
||||
- Built with Go backend and React frontend
|
||||
- Optimized for performance at any scale
|
||||
|
||||
- **🐳 Simple Deployment**
|
||||
|
||||
- One-line Docker installation
|
||||
- Supports SQLite, MySQL, and PostgreSQL
|
||||
|
||||
- **🔗 Developer-Friendly**
|
||||
|
||||
- Full REST and gRPC APIs
|
||||
- Easy integration with existing workflows
|
||||
|
||||
- **🎨 Beautiful Interface**
|
||||
- Clean, minimal design and dark mode support
|
||||
- Mobile-responsive layout
|
||||
- **Privacy-First** — Self-hosted on your infrastructure with zero telemetry, no tracking, and no ads.
|
||||
- **Markdown Native** — Full markdown support with plain text storage. Your data is always portable.
|
||||
- **Lightweight** — Single Go binary with a React frontend. Low memory footprint, starts in seconds.
|
||||
- **Easy to Deploy** — One-line Docker install. Supports SQLite, MySQL, and PostgreSQL.
|
||||
- **Developer-Friendly** — Full REST and gRPC APIs for integration with existing workflows.
|
||||
- **Clean Interface** — Minimal design with dark mode and mobile-responsive layout.
|
||||
|
||||
## Quick Start
|
||||
|
||||
|
|
@ -112,15 +78,13 @@ See our [installation guide](https://usememos.com/docs/deploy) for detailed inst
|
|||
|
||||
## Contributing
|
||||
|
||||
We welcome contributions of all kinds! Whether you're fixing bugs, adding features, improving documentation, or helping with translations — every contribution matters.
|
||||
Contributions are welcome — bug reports, feature suggestions, pull requests, documentation, and translations.
|
||||
|
||||
**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)
|
||||
- 🔧 [Submit pull requests](https://github.com/usememos/memos/pulls)
|
||||
- 📖 [Improve documentation](https://github.com/usememos/memos/tree/main/docs)
|
||||
- 🌍 [Help with translations](https://github.com/usememos/memos/tree/main/web/src/locales)
|
||||
- [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)
|
||||
- [Improve documentation](https://github.com/usememos/memos/tree/main/docs)
|
||||
- [Help with translations](https://github.com/usememos/memos/tree/main/web/src/locales)
|
||||
|
||||
## Sponsors
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue