mirror of
https://github.com/usememos/memos.git
synced 2025-02-06 09:45:29 +00:00
chore: update readme (#1047)
This commit is contained in:
parent
26700a1ff0
commit
bd9003c24b
@ -1,3 +1,2 @@
|
||||
# These owners will be the default owners for everything in the repo.
|
||||
|
||||
- @boojack
|
||||
* @boojack
|
||||
|
16
README.md
16
README.md
@ -1,7 +1,5 @@
|
||||
<p align="center"><a href="https://usememos.com"><img height="64px" src="https://raw.githubusercontent.com/usememos/memos/main/resources/logo-full.webp" alt="✍️ memos" /></a></p>
|
||||
|
||||
<p align="center">An open-source, self-hosted memo hub with knowledge management and socialization.</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/usememos/memos/stargazers"><img alt="GitHub stars" src="https://img.shields.io/github/stars/usememos/memos" /></a>
|
||||
<a href="https://hub.docker.com/r/neosmemo/memos"><img alt="Docker pull" src="https://img.shields.io/docker/pulls/neosmemo/memos.svg" /></a>
|
||||
@ -31,15 +29,13 @@
|
||||
docker run -d --name memos -p 5230:5230 -v ~/.memos/:/var/opt/memos neosmemo/memos:latest
|
||||
```
|
||||
|
||||
> The `~/.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.
|
||||
|
||||
If the `~/.memos/` does not have a `memos_prod.db` file, then memos will auto generate it. Memos will be running at [http://localhost:5230](http://localhost:5230).
|
||||
> `~/.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 Compose YAML file: [`docker-compose.yaml`](./docker-compose.yaml).
|
||||
Example docker compose YAML file: [`docker-compose.yaml`](./docker-compose.yaml).
|
||||
|
||||
If you want to upgrade the version of memos, use the following command.
|
||||
You can upgrade memos with the following command.
|
||||
|
||||
```sh
|
||||
docker-compose down && docker image rm neosmemo/memos:latest && docker-compose up -d
|
||||
@ -56,7 +52,7 @@ Contributions are what make the open source community such an amazing place to l
|
||||
|
||||
See more in [development guide](./docs/development.md).
|
||||
|
||||
## Products made by Community
|
||||
### Products made by Community
|
||||
|
||||
- [Moe Memos](https://memos.moe/) - Third party client for iOS and Android
|
||||
- [lmm214/memos-bber](https://github.com/lmm214/memos-bber) - Chrome extension
|
||||
@ -65,7 +61,7 @@ See more in [development guide](./docs/development.md).
|
||||
- [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
|
||||
|
||||
## User stories
|
||||
### User stories
|
||||
|
||||
- [Memos - A Twitter Like Notes App You can Self Host](https://noted.lol/memos/)
|
||||
|
||||
@ -77,7 +73,7 @@ See more in [development guide](./docs/development.md).
|
||||
|
||||
## License
|
||||
|
||||
This project is open source and available under the [MIT License](https://github.com/usememos/memos/blob/main/LICENSE).
|
||||
[MIT License](https://github.com/usememos/memos/blob/main/LICENSE).
|
||||
|
||||
## Star history
|
||||
|
||||
|
@ -49,7 +49,7 @@
|
||||
"vacuum": "Vacuum",
|
||||
"select": "Select"
|
||||
},
|
||||
"slogan": "An open-source, self-hosted memo hub with knowledge management and socialization.",
|
||||
"slogan": "An open-source, self-hosted memo hub with knowledge management and social networking.",
|
||||
"auth": {
|
||||
"signup-as-host": "Sign up as Host",
|
||||
"host-tip": "You are registering as the Site Host.",
|
||||
|
@ -49,7 +49,7 @@
|
||||
"vacuum": "Vacuum",
|
||||
"select": "Select"
|
||||
},
|
||||
"slogan": "An open-source, self-hosted memo hub with knowledge management and socialization.",
|
||||
"slogan": "An open-source, self-hosted memo hub with knowledge management and social networking.",
|
||||
"auth": {
|
||||
"signup-as-host": "S'inscrire en tant qu'hôte",
|
||||
"host-tip": "Vous vous inscrivez en tant qu'hébergeur du site.",
|
||||
|
@ -49,7 +49,7 @@
|
||||
"vacuum": "Pulisci",
|
||||
"select": "Seleziona"
|
||||
},
|
||||
"slogan": "An open-source, self-hosted memo hub with knowledge management and socialization.",
|
||||
"slogan": "An open-source, self-hosted memo hub with knowledge management and social networking.",
|
||||
"auth": {
|
||||
"signup-as-host": "Registrati come Host",
|
||||
"host-tip": "Ti stai registrando come Host del sito.",
|
||||
|
@ -49,7 +49,7 @@
|
||||
"vacuum": "清理",
|
||||
"select": "選擇"
|
||||
},
|
||||
"slogan": "An open-source, self-hosted memo hub with knowledge management and socialization.",
|
||||
"slogan": "An open-source, self-hosted memo hub with knowledge management and social networking.",
|
||||
"auth": {
|
||||
"signup-as-host": "註冊為管理員",
|
||||
"host-tip": "你正在註冊為管理員帳號。",
|
||||
|
@ -49,7 +49,7 @@
|
||||
"vacuum": "清理",
|
||||
"select": "选择"
|
||||
},
|
||||
"slogan": "An open-source, self-hosted memo hub with knowledge management and socialization.",
|
||||
"slogan": "An open-source, self-hosted memo hub with knowledge management and social networking.",
|
||||
"auth": {
|
||||
"signup-as-host": "注册为 Host",
|
||||
"host-tip": "你正在注册为 Host 用户账号。",
|
||||
|
Loading…
x
Reference in New Issue
Block a user