mirror of https://github.com/usememos/memos.git
chore: tweak README to enhance sponsorship and clarity
Updated README to include sponsorship details and enhance clarity on features and benefits. Signed-off-by: boojack <stevenlgtm@gmail.com>
This commit is contained in:
boojack
GitHub
parent
e4f6345342
commit
f2f2a5159c
206
README.md
206
README.md
|
|
@ -1,140 +1,148 @@
|
||||||
<!-- Premium Sponsors -->
|
|
||||||
<p align="center"><strong>Special thanks to our sponsor:</strong></p>
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<a href="https://go.warp.dev/memos" target="_blank" rel="noopener">
|
|
||||||
<img src="https://raw.githubusercontent.com/warpdotdev/brand-assets/main/Github/Sponsor/Warp-Github-LG-02.png" alt="Warp" height="256" />
|
<img height="96px" src="https://raw.githubusercontent.com/usememos/.github/refs/heads/main/assets/logo-rounded.png" alt="Memos" />
|
||||||
</a>
|
|
||||||
<p>
|
|
||||||
<a href="https://go.warp.dev/memos" target="_blank" rel="noopener">Warp is built for coding with multiple AI agents</a>
|
|
||||||
</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
# Memos
|
# Memos
|
||||||
|
|
||||||
<img align="right" height="96px" src="https://raw.githubusercontent.com/usememos/.github/refs/heads/main/assets/logo-rounded.png" alt="Memos" />
|
**A privacy-first, lightweight note-taking service**
|
||||||
|
|
||||||
A modern, open-source, self-hosted knowledge management and note-taking platform designed for privacy-conscious users and organizations. Memos provides a lightweight yet powerful solution for capturing, organizing, and sharing thoughts with comprehensive Markdown support and cross-platform accessibility.
|
Write, organize, and own your knowledge
|
||||||
|
|
||||||
<div align="center">
|
[](https://www.usememos.com)
|
||||||
|
[](https://demo.usememos.com/)
|
||||||
|
[](https://www.usememos.com/docs)
|
||||||
|
[](https://discord.gg/tfPJa4UmAv)
|
||||||
|
[](https://hub.docker.com/r/neosmemo/memos)
|
||||||
|
|
||||||
[](https://www.usememos.com)
|
### 💎 Sponsored By
|
||||||
[](https://www.usememos.com/docs)
|
|
||||||
[](https://demo.usememos.com/)
|
|
||||||
[](https://www.usememos.com/blog)
|
|
||||||
|
|
||||||
[](https://hub.docker.com/r/neosmemo/memos)
|
<a href="https://go.warp.dev/memos" target="_blank" rel="noopener">
|
||||||
[](https://hub.docker.com/r/neosmemo/memos)
|
<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" />
|
||||||
[](https://discord.gg/tfPJa4UmAv)
|
</a>
|
||||||
|
|
||||||
|
**[Warp](https://go.warp.dev/memos)** — The AI-powered terminal built for speed and collaboration
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
## 🎯 Why Memos?
|
||||||
|
|
||||||
<!-- Premium Sponsors -->
|
**Your thoughts. Your data. Your control.**
|
||||||
<!--
|
|
||||||
<div align="center">
|
|
||||||
<p><em>Support Memos development and get your brand featured here</em></p>
|
|
||||||
<a href="https://sponsor-website.com" target="_blank">
|
|
||||||
<img src="https://sponsor-logo-url.com/logo.png" alt="Sponsor Name" height="60" style="margin: 10px;">
|
|
||||||
</a>
|
|
||||||
</div>
|
|
||||||
-->
|
|
||||||
|
|
||||||
## Table of Contents
|
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.
|
||||||
|
|
||||||
- [Table of Contents](#table-of-contents)
|
- 🔒 **Privacy by design** — All data stays on your server
|
||||||
- [Overview](#overview)
|
- ⚡ **Lightning fast** — Built with Go and React for speed
|
||||||
- [Key Features](#key-features)
|
- 📝 **Markdown native** — Write naturally with full markdown support
|
||||||
- [Quick Start](#quick-start)
|
- 🐳 **Deploy in seconds** — One Docker command to get started
|
||||||
- [Sponsors](#sponsors)
|
- 🎨 **Beautiful & minimal** — Focus on your thoughts, not the UI
|
||||||
- [Contributing](#contributing)
|
- 🔗 **API-first** — Integrate with your workflow seamlessly
|
||||||
- [Star History](#star-history)
|
|
||||||
|
|
||||||
## Overview
|
## 🚀 Quick Start
|
||||||
|
|
||||||
Memos is a lightweight, self-hosted alternative to cloud-based note-taking services. Built with privacy and performance in mind, it offers a comprehensive platform for personal knowledge management without compromising data ownership or security.
|
|
||||||
|
|
||||||
## Key Features
|
|
||||||
|
|
||||||
### Privacy & Security
|
|
||||||
|
|
||||||
- **Complete Data Ownership** — All data stored locally in your chosen database
|
|
||||||
- **Self-Hosted Architecture** — Full control over infrastructure and access policies
|
|
||||||
- **No External Dependencies** — Zero third-party services or cloud connections required
|
|
||||||
|
|
||||||
### Content Creation
|
|
||||||
|
|
||||||
- **Instant Save** — Streamlined plain text input with automatic persistence
|
|
||||||
- **Rich Markdown Support** — Full Markdown rendering with syntax highlighting
|
|
||||||
- **Media Integration** — Native support for images, links, and embedded content
|
|
||||||
|
|
||||||
### Performance & Technology
|
|
||||||
|
|
||||||
- **High-Performance Backend** — Built with Go for optimal resource utilization
|
|
||||||
- **Modern React Frontend** — Responsive, intuitive user interface
|
|
||||||
- **Lightweight Deployment** — Minimal system requirements, maximum efficiency
|
|
||||||
- **Cross-Platform** — Linux, macOS, Windows, and containerized environments
|
|
||||||
|
|
||||||
### Customization
|
|
||||||
|
|
||||||
- **Configurable Interface** — Custom branding, themes, and UI elements
|
|
||||||
- **API-First Design** — RESTful API for seamless third-party integrations
|
|
||||||
- **Multi-Database Support** — SQLite, PostgreSQL, and MySQL compatibility
|
|
||||||
|
|
||||||
### Cost-Effective
|
|
||||||
|
|
||||||
- **Open Source (MIT)** — Full source code availability with permissive licensing
|
|
||||||
- **Zero Subscription Fees** — No usage limits, premium tiers, or hidden costs
|
|
||||||
- **Community-Driven** — Transparent development with active community support
|
|
||||||
|
|
||||||
## Quick Start
|
|
||||||
|
|
||||||
Get Memos running in under 1 minutes with Docker:
|
|
||||||
|
|
||||||
|
Get up and running in **under 30 seconds**:
|
||||||
```bash
|
```bash
|
||||||
docker run -d \
|
docker run -d \
|
||||||
--name memos \
|
--name memos \
|
||||||
--restart unless-stopped \
|
|
||||||
-p 5230:5230 \
|
-p 5230:5230 \
|
||||||
-v ~/.memos:/var/opt/memos \
|
-v ~/.memos:/var/opt/memos \
|
||||||
neosmemo/memos:stable
|
neosmemo/memos:stable
|
||||||
```
|
```
|
||||||
|
|
||||||
Access Memos at `http://localhost:5230` and complete the initial setup.
|
Open `http://localhost:5230` and start writing! 🎉
|
||||||
|
|
||||||
**Alternative methods**: For Docker Compose, binary installation, or building from source, see our [Installation Guide](https://www.usememos.com/docs/installation).
|
**Need more options?** Check out our [installation guide](https://www.usememos.com/docs/installation) for Docker Compose, binaries, and building from source.
|
||||||
|
|
||||||
**Pro Tip**: The data directory stores all your notes, uploads, and settings. Include it in your backup strategy!
|
## ✨ Features
|
||||||
|
|
||||||
## Sponsors
|
<table>
|
||||||
|
<tr>
|
||||||
|
<td width="50%">
|
||||||
|
|
||||||
Memos is made possible by the generous support of our sponsors. Their contributions help ensure the project's continued development, maintenance, and growth.
|
### 🔐 Privacy First
|
||||||
|
- Self-hosted on your infrastructure
|
||||||
|
- No telemetry or tracking
|
||||||
|
- Full data ownership
|
||||||
|
- Export anytime
|
||||||
|
|
||||||
<a href="https://github.com/warpdev" target="_blank"><img src="https://avatars.githubusercontent.com/u/71840468?s=200&v=4" alt="warp" height="60" /></a>
|
### 📱 Modern Experience
|
||||||
<a href="https://github.com/yourselfhosted" target="_blank"><img src="https://avatars.githubusercontent.com/u/140182318?v=4" alt="yourselfhosted" height="60" /></a>
|
- Clean, intuitive interface
|
||||||
<a href="https://github.com/fixermark" target="_blank"><img src="https://avatars.githubusercontent.com/u/169982?v=4" alt="fixermark" height="60" /></a>
|
- Mobile-responsive design
|
||||||
<a href="https://github.com/alik-agaev" target="_blank"><img src="https://avatars.githubusercontent.com/u/2662697?v=4" alt="alik-agaev" height="60" /></a>
|
- Real-time updates
|
||||||
|
- Dark mode support
|
||||||
|
|
||||||
<p><strong>Every contribution, no matter the size, makes a difference!</strong></p>
|
</td>
|
||||||
|
<td width="50%">
|
||||||
|
|
||||||
|
### 🛠️ Developer Friendly
|
||||||
|
- RESTful API
|
||||||
|
- SQLite, PostgreSQL, MySQL support
|
||||||
|
- Easy to deploy and scale
|
||||||
|
- Extensive documentation
|
||||||
|
|
||||||
|
### 🌍 Open Source
|
||||||
|
- MIT licensed
|
||||||
|
- Active community
|
||||||
|
- Regular updates
|
||||||
|
- Transparent development
|
||||||
|
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
## 💡 Perfect For
|
||||||
|
|
||||||
|
- 📓 **Personal journaling** — Daily thoughts and reflections
|
||||||
|
- 🧠 **Knowledge management** — Build your second brain
|
||||||
|
- 📋 **Quick notes** — Capture ideas on the go
|
||||||
|
- 🔗 **Link collections** — Save and organize useful resources
|
||||||
|
- 👥 **Team wikis** — Collaborative knowledge bases
|
||||||
|
- 🎓 **Learning logs** — Document your learning journey
|
||||||
|
|
||||||
|
## 💖 Support Memos
|
||||||
|
|
||||||
|
Love Memos? Help us keep it growing!
|
||||||
|
|
||||||
<a href="https://github.com/sponsors/usememos" target="_blank">
|
<a href="https://github.com/sponsors/usememos" target="_blank">
|
||||||
<img src="https://img.shields.io/badge/Sponsor-❤️-red?style=for-the-badge" alt="Sponsor Memos">
|
<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>
|
</a>
|
||||||
|
|
||||||
## Contributing
|
**Community Sponsors:**
|
||||||
|
|
||||||
Memos welcomes contributions from developers, designers, and users worldwide. We value quality, innovation, and community feedback.
|
<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>
|
||||||
|
|
||||||
**Ways to Contribute:**
|
*Every contribution, big or small, makes a difference!*
|
||||||
|
|
||||||
- Code contributions (bug fixes, features, performance improvements)
|
## 🤝 Contributing
|
||||||
- Documentation and user guides
|
|
||||||
- Testing and bug reporting
|
|
||||||
- Localization and translation
|
|
||||||
- Community support
|
|
||||||
|
|
||||||
**Get Started**: [Contributing Guide](https://github.com/usememos/memos/blob/main/CONTRIBUTING.md) • [Code of Conduct](https://github.com/usememos/memos/blob/main/CODE_OF_CONDUCT.md)
|
We love contributions! Whether you're fixing bugs, adding features, improving docs, or spreading the word — every contribution matters.
|
||||||
|
|
||||||
## Star History
|
**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)
|
||||||
|
- 📖 [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
|
||||||
|
|
||||||
[](https://star-history.com/#usememos/memos&Date)
|
[](https://star-history.com/#usememos/memos&Date)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
**[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)**
|
||||||
|
|
||||||
|
Made with ❤️ by the Memos community
|
||||||
|
|
||||||
|
**If you like Memos, give us a ⭐ on GitHub!**
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue