usememos/memos
1
1
Fork 0
mirror of https://github.com/usememos/memos.git synced 2024-12-26 23:22:47 +08:00
Code Issues Projects Releases Packages Wiki Activity

chore: update readme (#375)

Browse source
This commit is contained in:
boojack 2022-10-30 14:42:56 +08:00 committed by GitHub
parent 29966451b6
commit 6cbc3c78e2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -1,6 +1,6 @@
<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 knowledge base that works with a SQLite db file.</p> <p align="center">An open-source, self-hosted memo hub for knowledge management and collaboration.</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>
@ -17,14 +17,13 @@
## Features ## Features
- 🦄 Fully open source; - 🦄 Open source and forever free;
- 📜 Writing in plain textarea without any burden, - 🚀 Support for self-hosting with `Docker` in seconds;
- and support some useful markdown syntax 💪. - 📜 Plain textarea first and support some useful markdown syntax;
- 🌄 Share the memo in a pretty image or personal page like Twitter; - 👥 Collaborate and share with your teammates;
- 🚀 Fast self-hosting with `Docker`; - 🧑‍💻 RESTful API for self-service.
- 🤠 Pleasant UI and UX;
## Deploy with Docker ## Deploy with Docker in seconds
### Docker Run ### Docker Run
@ -44,11 +43,17 @@ If you want to upgrade the version of memos, use the following command.
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
``` ```
## Contributing ## Contribute
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. 🥰 Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. 🥰
Gets more about [development guide](https://github.com/usememos/memos/tree/main/docs/development.md). Gets more information in [development guide](https://github.com/usememos/memos/tree/main/docs/development.md).
## Community Products
- [Moe Memos](https://memos.moe/) - Third party client for iOS and Android
- [lmm214/memos-bber](https://github.com/lmm214/memos-bber) - Memos 的 Chrome 扩展
- [Rabithua/memos_wmp](https://github.com/Rabithua/memos_wmp) - 微信小程序版
## Star history ## Star history