Memos is an open-source, self-hosted note-taking app that brings your everyday thoughts together in a personal timeline. Your data stays yours, and you choose what to keep private or share.
Go dockerfossgomarkdownmemomicroblognote-takingnotesopen-sourceown-your-datareactself-hostedsqlitetimeline
chore: tweak README
boojackdcef4188dbfb
diff --git a/README.md b/README.mdindex 189a83ca5..388391931 100644--- a/README.md+++ b/README.md@@ -1,71 +1,56 @@-> ✨ Featured Sponsor: [CodeRabbit](https://coderabbit.link/usememos) — Cut code review time & bugs in half, instantly.+> **Featured sponsor:** [CodeRabbit](https://coderabbit.link/usememos) — Cut code review time and bugs in half, instantly.# Memos-<img align="right" height="96px" src="https://raw.githubusercontent.com/usememos/.github/refs/heads/main/assets/logo-rounded.png" alt="Memos" />+<img src="./web/public/logo.webp" alt="" width="96" align="right">-Memos is an open-source, self-hosted note-taking app built for quick capture. It is Markdown-native, lightweight, and keeps your data under your control.+**Fast enough for every thought. Private enough for all of them.**-[](https://usememos.com)-[](https://demo.usememos.com/)-[](https://usememos.com/docs)-[](https://discord.gg/tfPJa4UmAv)-[](https://hub.docker.com/r/neosmemo/memos)+Memos is an open-source, self-hosted home for short-form thinking. Daily notes, links, work logs, and snippets flow into a chronological Markdown timeline—on infrastructure you control, without the overhead of an all-in-one workspace.++**[Run with Docker](#quick-start)** · **[Try the live demo](https://demo.usememos.com/)** · [Read the docs](https://usememos.com/docs)++[](https://github.com/usememos/memos)+[](https://github.com/usememos/memos/releases)+[](https://hub.docker.com/r/neosmemo/memos)+[](LICENSE)<img src="https://raw.githubusercontent.com/usememos/.github/refs/heads/main/assets/demo.png" alt="Memos Demo Screenshot" height="512" />-## Features+## Why Memos?-- **Capture quickly** — A timeline-first interface keeps note-taking simple: open, write, and move on.-- **Own your data** — Self-host Memos on your infrastructure with no telemetry.-- **Deploy anywhere** — Run a single Go binary or Docker container with SQLite, MySQL, or PostgreSQL.-- **Integrate freely** — Build on the REST and gRPC APIs or adapt the MIT-licensed source to your needs.+- **Capture quickly** — Write in Markdown, attach media, and save without choosing a title, folder, or template.+- **Organize lightly** — Revisit notes through the timeline, search, tags, and pins.+- **Share selectively** — Keep memos private or publish only what you choose.+- **Keep control** — Self-host Memos with [zero telemetry](https://usememos.com/features/data-ownership) and [MIT-licensed source](LICENSE).-## Quick Start+[Explore all features →](https://usememos.com/features)-Want to explore Memos first? Open the [live demo](https://demo.usememos.com/).+## Quick Start-### Docker (Recommended)+Start a private Memos instance with one Docker command:```bashdocker run -d \--name memos \- -p 5230:5230 \+ --restart unless-stopped \+ -p 127.0.0.1:5230:5230 \-v ~/.memos:/var/opt/memos \neosmemo/memos:stable```-Open `http://localhost:5230` and start writing.+Open [http://localhost:5230](http://localhost:5230) and start writing. See the [deployment guide](https://usememos.com/docs/deploy) for other installation options.-### Native Binary--Native macOS binaries require macOS 13 Ventura or later.--```bash-curl -fsSL https://raw.githubusercontent.com/usememos/memos/main/scripts/install.sh | sh-```+## Extend Memos-### Other Installation Methods+- **[Web Clipper](https://usememos.com/web-clipper)** — Save pages, selections, and images as source-linked Markdown. Available for [Chrome](https://chromewebstore.google.com/detail/memos-web-clipper/nebaoebnljalfegiidibihhkebeiklbl) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/memos-web-clipper/).+- **[API and webhooks](https://usememos.com/docs/api)** — Connect scripts, bots, and custom capture flows through REST, gRPC, and [webhooks](https://usememos.com/docs/integrations/webhooks).-- **Docker Compose** — Recommended for production deployments.-- **Kubernetes** — Helm charts and manifests are available.-- **Build from source** — Best for development and customization.+## Get Help-See the [deployment guide](https://usememos.com/docs/deploy) for detailed instructions.+Read the [documentation](https://usememos.com/docs), join [Discord](https://discord.gg/tfPJa4UmAv), or ask in [GitHub Discussions](https://github.com/usememos/memos/discussions). You can also [report a bug](https://github.com/usememos/memos/issues/new?template=bug_report.yml) or [suggest a feature](https://github.com/usememos/memos/issues/new?template=feature_request.yml).-## Web Clipper--Save pages, selected text, and images directly to your Memos instance with the official [Memos Web Clipper](https://github.com/usememos/web-clipper). The extension is available for [Chrome](https://chromewebstore.google.com/detail/memos-web-clipper/nebaoebnljalfegiidibihhkebeiklbl) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/memos-web-clipper/), and lets you review each clip, choose its visibility, and customize its Markdown format before saving.--## Contributing--Contributions of all kinds are welcome, including bug reports, feature suggestions, pull requests, documentation, and translations.--- [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/dotcom)-- [Help with translations](https://github.com/usememos/memos/tree/main/web/src/locales)+Want to contribute? See the [contributing guide](https://usememos.com/docs/development/contributing).## Sponsors@@ -73,25 +58,8 @@ Contributions of all kinds are welcome, including bug reports, feature suggestio- [**SSD Nodes** — Affordable VPS hosting for self-hosters](https://ssdnodes.com/?utm_source=memos&utm_medium=sponsor)- [**TestMu AI** — The world’s first full-stack Agentic AI Quality Engineering platform](https://www.testmuai.com/?utm_medium=sponsor&utm_source=memos)-Love Memos? [Sponsor us on GitHub](https://github.com/sponsors/usememos) to help keep the project growing!+Love Memos? [Sponsor the project on GitHub](https://github.com/sponsors/usememos).## License-Memos is open-source software licensed under the [MIT License](LICENSE). See our [Privacy Policy](https://usememos.com/privacy) for details on data handling.-------[Website](https://usememos.com) • [Documentation](https://usememos.com/docs) • [Demo](https://demo.usememos.com/) • [Discord](https://discord.gg/tfPJa4UmAv) • [X/Twitter](https://x.com/usememos)--<p>- <picture>- <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/badge?repo=usememos/memos&type=rank&theme=dark" />- <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/badge?repo=usememos/memos&type=rank" />- <img alt="Star History Rank" src="https://api.star-history.com/badge?repo=usememos/memos&type=rank" />- </picture>- <picture>- <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/badge?repo=usememos/memos&type=trending&theme=dark" />- <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/badge?repo=usememos/memos&type=trending" />- <img alt="GitHub Trending Repository of the Day" src="https://api.star-history.com/badge?repo=usememos/memos&type=trending" />- </picture>-</p>+Memos is licensed under the [MIT License](LICENSE).