Skip to content

armgit / memos

Public Imported from GitHub
0

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.

chore: simplify readme (#1275)

boojack6201dcf1aafa
diff --git a/README.md b/README.md
index 13521180d..bc9c1bb0b 100644
--- a/README.md
+++ b/README.md
@@ -14,79 +14,48 @@
![demo](https://usememos.com/demo.webp)
-## Features
-
-- πŸ¦„ Open source and free forever
-- πŸš€ Support for self-hosting with `Docker` in seconds
-- πŸ“œ Plain textarea first and support some useful Markdown syntax
-- πŸ‘₯ Set memo private or public to others
-- πŸ§‘β€πŸ’» RESTful API for self-service
-- πŸ“‹ Embed memos on other sites using iframe
-- #️⃣ Hashtags for organizing memos
-- πŸ“† Interactive calendar view
-- πŸ’Ύ Easy data migration and backups
+## Key points
-## Deploy with Docker in seconds
+- Open source and free forever
+- Self-hosting with Docker in seconds
+- Markdown support
+- Customizable and sharable
+- RESTful API for self-service
-### Docker Run
+## Deploy with Docker in seconds
-```docker
+```bash
docker run -d --name memos -p 5230:5230 -v ~/.memos/:/var/opt/memos neosmemo/memos:latest
```
-> `~/.memos/` will be used as the data directory in your machine and `/var/opt/memos` is the directory of the volume in Docker and should not be modified.
-
-### Docker Compose
-
-- Provided docker compose YAML file: [`docker-compose.yaml`](./docker-compose.yaml).
-
-- You can upgrade to the latest version memos with:
-
-```sh
-docker-compose down && docker image rm neosmemo/memos:latest && docker-compose up -d
-```
-
-### Other installation methods
+> The `~/.memos/` directory will be used as the data directory on your local machine, while `/var/opt/memos` is the directory of the volume in Docker and should not be modified.
-- [Deploy on render.com](./docs/deploy-with-render.md)
-- [Deploy on fly.io](https://github.com/hu3rror/memos-on-fly)
+Learn more about [other installation methods](https://usememos.com/docs/install).
-## Contribute
+## Contribution
-Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. πŸ₯°
+Contributions are what make the open-source community such an amazing place to learn, inspire, and create. We greatly appreciate any contributions you make. Thank you for being a part of our community! πŸ₯°
-Learn more about contributing in [development guide](./docs/development.md).
+<a href="https://github.com/usememos/memos/graphs/contributors">
+ <img src="https://contrib.rocks/image?repo=usememos/memos" />
+</a>
-### Products made by our Community
+Here are some products made by our community:
- [Moe Memos](https://memos.moe/) - Third party client for iOS and Android
- [lmm214/memos-bber](https://github.com/lmm214/memos-bber) - Chrome extension
- [Rabithua/memos_wmp](https://github.com/Rabithua/memos_wmp) - WeChat MiniProgram
- [qazxcdswe123/telegramMemoBot](https://github.com/qazxcdswe123/telegramMemoBot) - Telegram bot
-- [eallion/memos.top](https://github.com/eallion/memos.top) - A static page rendered with the Memos API
-- [eindex/logseq-memos-sync](https://github.com/EINDEX/logseq-memos-sync) - A Logseq plugin
-- [JakeLaoyu/memos-import-from-flomo](https://github.com/JakeLaoyu/memos-import-from-flomo) - Import data. Support from flomo, wechat reading.
-- [Send to memos](https://sharecuts.cn/shortcut/12640) - A shortcut for iOS.
-- [Memos Raycast Extension](https://www.raycast.com/JakeYu/memos) - Raycast extension, [source code](https://github.com/JakeLaoyu/memos-raycast).
-
-### User stories
-
-- [Memos - A Twitter Like Notes App You can Self Host](https://noted.lol/memos/)
-
-### Join the community to build memos together!
-
-<a href="https://github.com/usememos/memos/graphs/contributors">
- <img src="https://contrib.rocks/image?repo=usememos/memos" />
-</a>
+- [eallion/memos.top](https://github.com/eallion/memos.top) - Static page rendered with the Memos API
+- [eindex/logseq-memos-sync](https://github.com/EINDEX/logseq-memos-sync) - Logseq plugin
+- [JakeLaoyu/memos-import-from-flomo](https://github.com/JakeLaoyu/memos-import-from-flomo) - Import data. Support from flomo, wechat reading
+- [Send to memos](https://sharecuts.cn/shortcut/12640) - A shortcut for iOS
+- [Memos Raycast Extension](https://www.raycast.com/JakeYu/memos) - Raycast extension
## Acknowledgements
- Thanks [Uffizzi](https://www.uffizzi.com/) for sponsoring preview environments for PRs.
-## License
-
-[MIT License](https://github.com/usememos/memos/blob/main/LICENSE)
-
## Star history
[![Star History Chart](https://api.star-history.com/svg?repos=usememos/memos&type=Date)](https://star-history.com/#usememos/memos&Date)