diff --git a/README.md b/README.md index 84dd86dd..9cb0f81e 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@
Live Demo • - Discuss in Telegram / Discord 🏂 + Discuss in Telegram / Discord
![demo](./resources/demo.webp#gh-light-mode-only) @@ -17,11 +17,15 @@ ## 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. +- 🦄 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 ## Deploy with Docker in seconds @@ -31,19 +35,19 @@ 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. +> `~/.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 -Example docker compose YAML file: [`docker-compose.yaml`](./docker-compose.yaml). +- Provided docker compose YAML file: [`docker-compose.yaml`](./docker-compose.yaml). -You can upgrade memos with the following command. +- You can upgrade to the latest version memos with: ```sh docker-compose down && docker image rm neosmemo/memos:latest && docker-compose up -d ``` -### Other guides +### Other installation methods - [Deploy on render.com](./docs/deploy-with-render.md) - [Deploy on fly.io](https://github.com/hu3rror/memos-on-fly) @@ -52,9 +56,9 @@ docker-compose down && docker image rm neosmemo/memos:latest && docker-compose u Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. 🥰 -See more in [development guide](./docs/development.md). +Learn more about contributing in [development guide](./docs/development.md). -### Products made by Community +### 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 @@ -81,7 +85,7 @@ See more in [development guide](./docs/development.md). ## License -[MIT License](https://github.com/usememos/memos/blob/main/LICENSE). +[MIT License](https://github.com/usememos/memos/blob/main/LICENSE) ## Star history