mirror of
https://github.com/usememos/memos.git
synced 2025-06-05 22:09:59 +02:00
chore: simplify readme (#1275)
This commit is contained in:
boojack
GitHub
77
README.md
77
README.md
@@ -14,79 +14,48 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Features
|
## Key points
|
||||||
|
|
||||||
- 🦄 Open source and free forever
|
- Open source and free forever
|
||||||
- 🚀 Support for self-hosting with `Docker` in seconds
|
- Self-hosting with Docker in seconds
|
||||||
- 📜 Plain textarea first and support some useful Markdown syntax
|
- Markdown support
|
||||||
- 👥 Set memo private or public to others
|
- Customizable and sharable
|
||||||
- 🧑💻 RESTful API for self-service
|
- RESTful API for self-service
|
||||||
- 📋 Embed memos on other sites using iframe
|
|
||||||
- #️⃣ Hashtags for organizing memos
|
|
||||||
- 📆 Interactive calendar view
|
|
||||||
- 💾 Easy data migration and backups
|
|
||||||
|
|
||||||
## Deploy with Docker in seconds
|
## Deploy with Docker in seconds
|
||||||
|
|
||||||
### Docker Run
|
```bash
|
||||||
|
|
||||||
```docker
|
|
||||||
docker run -d --name memos -p 5230:5230 -v ~/.memos/:/var/opt/memos neosmemo/memos:latest
|
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.
|
> 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.
|
||||||
|
|
||||||
### Docker Compose
|
Learn more about [other installation methods](https://usememos.com/docs/install).
|
||||||
|
|
||||||
- Provided docker compose YAML file: [`docker-compose.yaml`](./docker-compose.yaml).
|
## Contribution
|
||||||
|
|
||||||
- You can upgrade to the latest version memos with:
|
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! 🥰
|
||||||
|
|
||||||
```sh
|
|
||||||
docker-compose down && docker image rm neosmemo/memos:latest && docker-compose up -d
|
|
||||||
```
|
|
||||||
|
|
||||||
### Other installation methods
|
|
||||||
|
|
||||||
- [Deploy on render.com](./docs/deploy-with-render.md)
|
|
||||||
- [Deploy on fly.io](https://github.com/hu3rror/memos-on-fly)
|
|
||||||
|
|
||||||
## Contribute
|
|
||||||
|
|
||||||
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. 🥰
|
|
||||||
|
|
||||||
Learn more about contributing in [development guide](./docs/development.md).
|
|
||||||
|
|
||||||
### 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">
|
<a href="https://github.com/usememos/memos/graphs/contributors">
|
||||||
<img src="https://contrib.rocks/image?repo=usememos/memos" />
|
<img src="https://contrib.rocks/image?repo=usememos/memos" />
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
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) - 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
|
## Acknowledgements
|
||||||
|
|
||||||
- Thanks [Uffizzi](https://www.uffizzi.com/) for sponsoring preview environments for PRs.
|
- 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
|
||||||
|
|
||||||
[](https://star-history.com/#usememos/memos&Date)
|
[](https://star-history.com/#usememos/memos&Date)
|
||||||
|
|||||||
Reference in New Issue
Block a user