YourSelfHosted/memos
1
0
Fork 0
mirror of https://github.com/usememos/memos.git synced 2025-02-15 10:50:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

chore: make README more comprehensive (#1065)

Browse Source 
* Update README.md

* fix typos in readme

* Update README.md

---------

Co-authored-by: boojack <stevenlgtm@gmail.com>
This commit is contained in:
Ryan McPherson 2023-02-15 07:52:17 -05:00 committed by GitHub
parent 3394380ffa
commit 0de0a5aa87
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -8,7 +8,7 @@
<p align="center"> <p align="center">
<a href="https://demo.usememos.com/">Live Demo</a> • <a href="https://demo.usememos.com/">Live Demo</a> •
Discuss in <a href="https://t.me/+-_tNF1k70UU4ZTc9">Telegram</a> / <b><a href="https://discord.gg/tfPJa4UmAv">Discord 🏂</a></b> Discuss in <a href="https://t.me/+-_tNF1k70UU4ZTc9">Telegram</a> / <a href="https://discord.gg/tfPJa4UmAv">Discord</a>
</p> </p>
![demo](./resources/demo.webp#gh-light-mode-only) ![demo](./resources/demo.webp#gh-light-mode-only)
@ -17,11 +17,15 @@
## Features ## Features
- 🦄 Open source and free forever; - 🦄 Open source and free forever
- 🚀 Support for self-hosting with `Docker` in seconds; - 🚀 Support for self-hosting with `Docker` in seconds
- 📜 Plain textarea first and support some useful Markdown syntax; - 📜 Plain textarea first and support some useful Markdown syntax
- 👥 Set memo private or public to others; - 👥 Set memo private or public to others
- 🧑‍💻 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
@ -31,19 +35,19 @@
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. > `~/.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 ### 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 ```sh
docker-compose down && docker image rm neosmemo/memos:latest && docker-compose up -d 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 render.com](./docs/deploy-with-render.md)
- [Deploy on fly.io](https://github.com/hu3rror/memos-on-fly) - [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. 🥰 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 - [Moe Memos](https://memos.moe/) - Third party client for iOS and Android
- [lmm214/memos-bber](https://github.com/lmm214/memos-bber) - Chrome extension - [lmm214/memos-bber](https://github.com/lmm214/memos-bber) - Chrome extension
@ -81,7 +85,7 @@ See more in [development guide](./docs/development.md).
## License ## License
[MIT License](https://github.com/usememos/memos/blob/main/LICENSE). [MIT License](https://github.com/usememos/memos/blob/main/LICENSE)
## Star history ## Star history