From dcef4188dbfba767ea570dc0ecdeb258d17f3c25 Mon Sep 17 00:00:00 2001 From: boojack Date: Sun, 30 Aug 2026 12:49:04 +0800 Subject: [PATCH] chore: tweak README --- README.md | 92 ++++++++++++++++++------------------------------------- 1 file changed, 30 insertions(+), 62 deletions(-) diff --git a/README.md b/README.md index 189a83ca..38839193 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 -Memos + -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.** -[![Home](https://img.shields.io/badge/🏠-usememos.com-blue?style=flat-square)](https://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://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) +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) + +[![GitHub stars](https://img.shields.io/github/stars/usememos/memos?style=flat-square&logo=github&label=Stars)](https://github.com/usememos/memos) +[![Latest release](https://img.shields.io/github/v/release/usememos/memos?style=flat-square&label=Release)](https://github.com/usememos/memos/releases) +[![Docker pulls](https://img.shields.io/docker/pulls/neosmemo/memos?style=flat-square&logo=docker)](https://hub.docker.com/r/neosmemo/memos) +[![MIT license](https://img.shields.io/github/license/usememos/memos?style=flat-square)](LICENSE) Memos Demo Screenshot -## 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). + +[Explore all features β†’](https://usememos.com/features) ## Quick Start -Want to explore Memos first? Open the [live demo](https://demo.usememos.com/). - -### Docker (Recommended) +Start a private Memos instance with one Docker command: ```bash docker 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 +## Extend Memos -Native macOS binaries require macOS 13 Ventura or later. +- **[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). -```bash -curl -fsSL https://raw.githubusercontent.com/usememos/memos/main/scripts/install.sh | sh -``` +## Get Help -### Other Installation Methods +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). -- **Docker Compose** β€” Recommended for production deployments. -- **Kubernetes** β€” Helm charts and manifests are available. -- **Build from source** β€” Best for development and customization. - -See the [deployment guide](https://usememos.com/docs/deploy) for detailed instructions. - -## 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) - -

- - - - Star History Rank - - - - - GitHub Trending Repository of the Day - -

+Memos is licensed under the [MIT License](LICENSE).