chore: update readme (#1047)

This commit is contained in:
boojack 2023-02-08 08:51:36 +08:00 committed by GitHub
parent 26700a1ff0
commit bd9003c24b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 12 additions and 17 deletions

View file

@ -1,3 +1,2 @@
# These owners will be the default owners for everything in the repo. # These owners will be the default owners for everything in the repo.
* @boojack
- @boojack

View file

@ -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"><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"> <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://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> <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 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. > `~/.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).
### Docker Compose ### 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 ```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
@ -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). 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 - [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
@ -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 - [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 - [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/) - [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 ## 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 ## Star history

View file

@ -49,7 +49,7 @@
"vacuum": "Vacuum", "vacuum": "Vacuum",
"select": "Select" "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": { "auth": {
"signup-as-host": "Sign up as Host", "signup-as-host": "Sign up as Host",
"host-tip": "You are registering as the Site Host.", "host-tip": "You are registering as the Site Host.",

View file

@ -49,7 +49,7 @@
"vacuum": "Vacuum", "vacuum": "Vacuum",
"select": "Select" "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": { "auth": {
"signup-as-host": "S'inscrire en tant qu'hôte", "signup-as-host": "S'inscrire en tant qu'hôte",
"host-tip": "Vous vous inscrivez en tant qu'hébergeur du site.", "host-tip": "Vous vous inscrivez en tant qu'hébergeur du site.",

View file

@ -49,7 +49,7 @@
"vacuum": "Pulisci", "vacuum": "Pulisci",
"select": "Seleziona" "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": { "auth": {
"signup-as-host": "Registrati come Host", "signup-as-host": "Registrati come Host",
"host-tip": "Ti stai registrando come Host del sito.", "host-tip": "Ti stai registrando come Host del sito.",

View file

@ -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": { "auth": {
"signup-as-host": "註冊為管理員", "signup-as-host": "註冊為管理員",
"host-tip": "你正在註冊為管理員帳號。", "host-tip": "你正在註冊為管理員帳號。",

View file

@ -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": { "auth": {
"signup-as-host": "注册为 Host", "signup-as-host": "注册为 Host",
"host-tip": "你正在注册为 Host 用户账号。", "host-tip": "你正在注册为 Host 用户账号。",