Unverified Commit f2f2a515 authored by boojack's avatar boojack Committed by GitHub

chore: tweak README to enhance sponsorship and clarity

Updated README to include sponsorship details and enhance clarity on features and benefits.
Signed-off-by: 's avatarboojack <stevenlgtm@gmail.com>
parent e4f63453
<!-- 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"> [![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/)
[![Docs](https://img.shields.io/badge/📚-Documentation-green?style=flat-square)](https://www.usememos.com/docs)
[![Discord](https://img.shields.io/badge/💬-Discord-5865f2?style=flat-square&logo=discord&logoColor=white)](https://discord.gg/tfPJa4UmAv)
[![Docker Pulls](https://img.shields.io/docker/pulls/neosmemo/memos?style=flat-square&logo=docker)](https://hub.docker.com/r/neosmemo/memos)
[![Home Page](https://img.shields.io/badge/Home-www.usememos.com-blue)](https://www.usememos.com) ### 💎 Sponsored By
[![Documentation](https://img.shields.io/badge/Docs-Available-green)](https://www.usememos.com/docs)
[![Live Demo](https://img.shields.io/badge/Demo-Try%20Now-orange)](https://demo.usememos.com/)
[![Blog](https://img.shields.io/badge/Blog-Read%20More-lightblue)](https://www.usememos.com/blog)
[![Docker Pulls](https://img.shields.io/docker/pulls/neosmemo/memos.svg)](https://hub.docker.com/r/neosmemo/memos) <a href="https://go.warp.dev/memos" target="_blank" rel="noopener">
[![Docker Image Size](https://img.shields.io/docker/image-size/neosmemo/memos?sort=semver)](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" />
[![Discord](https://img.shields.io/badge/discord-chat-5865f2?logo=discord&logoColor=f5f5f5)](https://discord.gg/tfPJa4UmAv) </a>
</div> **[Warp](https://go.warp.dev/memos)** — The AI-powered terminal built for speed and collaboration
![Memos Application Screenshot](https://raw.githubusercontent.com/usememos/.github/refs/heads/main/assets/demo.png) ![screenshot](https://raw.githubusercontent.com/usememos/.github/refs/heads/main/assets/demo.png)
<!-- Premium Sponsors -->
<!--
<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> </div>
-->
## Table of Contents ## 🎯 Why Memos?
- [Table of Contents](#table-of-contents) **Your thoughts. Your data. Your control.**
- [Overview](#overview)
- [Key Features](#key-features)
- [Quick Start](#quick-start)
- [Sponsors](#sponsors)
- [Contributing](#contributing)
- [Star History](#star-history)
## Overview 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.
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. - 🔒 **Privacy by design** — All data stays on your server
-**Lightning fast** — Built with Go and React for speed
- 📝 **Markdown native** — Write naturally with full markdown support
- 🐳 **Deploy in seconds** — One Docker command to get started
- 🎨 **Beautiful & minimal** — Focus on your thoughts, not the UI
- 🔗 **API-first** — Integrate with your workflow seamlessly
## Key Features ## 🚀 Quick Start
### Privacy & Security Get up and running in **under 30 seconds**:
```bash
docker run -d \
--name memos \
-p 5230:5230 \
-v ~/.memos:/var/opt/memos \
neosmemo/memos:stable
```
- **Complete Data Ownership** — All data stored locally in your chosen database Open `http://localhost:5230` and start writing! 🎉
- **Self-Hosted Architecture** — Full control over infrastructure and access policies
- **No External Dependencies** — Zero third-party services or cloud connections required
### Content Creation **Need more options?** Check out our [installation guide](https://www.usememos.com/docs/installation) for Docker Compose, binaries, and building from source.
- **Instant Save** — Streamlined plain text input with automatic persistence ## ✨ Features
- **Rich Markdown Support** — Full Markdown rendering with syntax highlighting
- **Media Integration** — Native support for images, links, and embedded content
### Performance & Technology <table>
<tr>
<td width="50%">
- **High-Performance Backend** — Built with Go for optimal resource utilization ### 🔐 Privacy First
- **Modern React Frontend** — Responsive, intuitive user interface - Self-hosted on your infrastructure
- **Lightweight Deployment** — Minimal system requirements, maximum efficiency - No telemetry or tracking
- **Cross-Platform** — Linux, macOS, Windows, and containerized environments - Full data ownership
- Export anytime
### Customization ### 📱 Modern Experience
- Clean, intuitive interface
- Mobile-responsive design
- Real-time updates
- Dark mode support
- **Configurable Interface** — Custom branding, themes, and UI elements </td>
- **API-First Design** — RESTful API for seamless third-party integrations <td width="50%">
- **Multi-Database Support** — SQLite, PostgreSQL, and MySQL compatibility
### Cost-Effective ### 🛠️ Developer Friendly
- RESTful API
- SQLite, PostgreSQL, MySQL support
- Easy to deploy and scale
- Extensive documentation
- **Open Source (MIT)** — Full source code availability with permissive licensing ### 🌍 Open Source
- **Zero Subscription Fees** — No usage limits, premium tiers, or hidden costs - MIT licensed
- **Community-Driven** — Transparent development with active community support - Active community
- Regular updates
- Transparent development
## Quick Start </td>
</tr>
</table>
Get Memos running in under 1 minutes with Docker: ## 💡 Perfect For
```bash - 📓 **Personal journaling** — Daily thoughts and reflections
docker run -d \ - 🧠 **Knowledge management** — Build your second brain
--name memos \ - 📋 **Quick notes** — Capture ideas on the go
--restart unless-stopped \ - 🔗 **Link collections** — Save and organize useful resources
-p 5230:5230 \ - 👥 **Team wikis** — Collaborative knowledge bases
-v ~/.memos:/var/opt/memos \ - 🎓 **Learning logs** — Document your learning journey
neosmemo/memos:stable
```
Access Memos at `http://localhost:5230` and complete the initial setup. ## 💖 Support Memos
**Alternative methods**: For Docker Compose, binary installation, or building from source, see our [Installation Guide](https://www.usememos.com/docs/installation). Love Memos? Help us keep it growing!
**Pro Tip**: The data directory stores all your notes, uploads, and settings. Include it in your backup strategy! <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>
## Sponsors **Community Sponsors:**
Memos is made possible by the generous support of our sponsors. Their contributions help ensure the project's continued development, maintenance, and growth. <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>
<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> *Every contribution, big or small, makes a difference!*
<a href="https://github.com/yourselfhosted" target="_blank"><img src="https://avatars.githubusercontent.com/u/140182318?v=4" alt="yourselfhosted" height="60" /></a>
<a href="https://github.com/fixermark" target="_blank"><img src="https://avatars.githubusercontent.com/u/169982?v=4" alt="fixermark" height="60" /></a>
<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>
<p><strong>Every contribution, no matter the size, makes a difference!</strong></p> ## 🤝 Contributing
<a href="https://github.com/sponsors/usememos" target="_blank"> We love contributions! Whether you're fixing bugs, adding features, improving docs, or spreading the word — every contribution matters.
<img src="https://img.shields.io/badge/Sponsor-❤️-red?style=for-the-badge" alt="Sponsor Memos">
</a>
## Contributing **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)
Memos welcomes contributions from developers, designers, and users worldwide. We value quality, innovation, and community feedback. ## ⭐ Star History
**Ways to Contribute:** [![Star History Chart](https://api.star-history.com/svg?repos=usememos/memos&type=Date)](https://star-history.com/#usememos/memos&Date)
- Code contributions (bug fixes, features, performance improvements) ---
- 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) <div align="center">
## Star History **[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)**
[![Star History Chart](https://api.star-history.com/svg?repos=usememos/memos&type=Date)](https://star-history.com/#usememos/memos&Date) Made with ❤️ by the Memos community
**If you like Memos, give us a ⭐ on GitHub!**
</div>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment