Commit a83426f3 authored by Vũ Hoàng Anh's avatar Vũ Hoàng Anh

docs: rebrand README to Canifa Note

parent 6db954ba
Pipeline #3437 failed with stages
<div align="center"> # Canifa Note
<p>
<span>Featured Sponsor:</span>
<a href="https://go.warp.dev/memos" target="_blank" rel="noopener">
<b>Warp</b>
<span>— The AI-powered terminal built for speed and collaboration</span>
</a>
</p>
<a href="https://go.warp.dev/memos" target="_blank" rel="noopener">
<img alt="Warp sponsorship" height="196" src="https://raw.githubusercontent.com/warpdotdev/brand-assets/refs/heads/main/Github/Sponsor/Warp-Github-LG-03.png">
</a>
</div>
# Memos <img align="right" height="96px" src="./public/image.png" alt="Canifa Note Logo" />
<img align="right" height="96px" src="https://raw.githubusercontent.com/usememos/.github/refs/heads/main/assets/logo-rounded.png" alt="Memos" /> Internal open-source, self-hosted note-taking tool built for quick capture for Canifa teams. Markdown-native, lightweight, and fully customized from [Memos](https://github.com/usememos/memos).
Open-source, self-hosted note-taking tool built for quick capture. Markdown-native, lightweight, and fully yours.
[![Home](https://img.shields.io/badge/🏠-usememos.com-blue?style=flat-square)](https://usememos.com)
[![Live Demo](https://img.shields.io/badge/✨-Try%20Demo-orange?style=flat-square)](https://demo.usememos.com/)
[![Docs](https://img.shields.io/badge/📚-Documentation-green?style=flat-square)](https://usememos.com/docs)
[![Discord](https://img.shields.io/badge/💬-Discord-5865f2?style=flat-square&logo=discord&logoColor=white)](https://discord.gg/tfPJa4UmAv)
[![Docker Pulls](https://img.shields.io/docker/pulls/neosmemo/memos?style=flat-square&logo=docker)](https://hub.docker.com/r/neosmemo/memos)
<img src="https://raw.githubusercontent.com/usememos/.github/refs/heads/main/assets/demo.png" alt="Memos Demo Screenshot" height="512" />
### 💎 Featured Sponsors
[**Warp** — The AI-powered terminal built for speed and collaboration](https://go.warp.dev/memos)
<a href="https://go.warp.dev/memos" target="_blank" rel="noopener">
<img src="https://raw.githubusercontent.com/warpdotdev/brand-assets/refs/heads/main/Logos/Warp-Wordmark-Black.png" alt="Warp - The AI-powered terminal built for speed and collaboration" height="44" />
</a>
<p></p>
[**TestMu AI** - The world’s first full-stack Agentic AI Quality Engineering platform](https://www.testmuai.com/?utm_medium=sponsor&utm_source=memos)
<a href="https://www.testmuai.com/?utm_medium=sponsor&utm_source=memos" target="_blank" rel="noopener">
<img src="https://usememos.com/sponsors/testmu.svg" alt="TestMu AI" height="36" />
</a>
<p></p>
[**SSD Nodes** - Affordable VPS hosting for self-hosters](https://ssdnodes.com/?utm_source=memos&utm_medium=sponsor)
<a href="https://ssdnodes.com/?utm_source=memos&utm_medium=sponsor" target="_blank" rel="noopener">
<img src="https://usememos.com/sponsors/ssd-nodes.svg" alt="SSD Nodes" height="72" />
</a>
## Features ## Features
- **Instant Capture** — Timeline-first UI. Open, write, done — no folders to navigate. - **Instant Capture** — Timeline-first UI. Open, write, done — no folders to navigate.
- **Total Data Ownership** — Self-hosted on your infrastructure. Notes stored in Markdown, always portable. Zero telemetry. - **Total Data Ownership** — Self-hosted on Canifa infrastructure. Notes stored in Markdown, always portable. Zero telemetry.
- **Radical Simplicity** — Single Go binary, ~20MB Docker image. One command to deploy with SQLite, MySQL, or PostgreSQL. - **Radical Simplicity** — Single Go binary, lightweight Docker image.
- **Open & Extensible** — MIT-licensed with full REST and gRPC APIs for integration. - **Customized for Canifa** — Built and wrapped specifically for internal use.
## Quick Start ## Quick Start (Canifa Wrapper)
### Docker (Recommended) ### Docker Compose (Recommended)
```bash ```bash
docker run -d \ # Run the custom auto-build script
--name memos \ ./auto-build.sh
-p 5230:5230 \
-v ~/.memos:/var/opt/memos \
neosmemo/memos:stable
``` ```
Open `http://localhost:5230` and start writing! Or run directly with docker-compose:
### Native Binary
```bash ```bash
curl -fsSL https://raw.githubusercontent.com/usememos/memos/main/scripts/install.sh | sh docker-compose up -d
``` ```
### Try the Live Demo Open `http://localhost:5230` and start writing!
Don't want to install yet? Try our [live demo](https://demo.usememos.com/) first!
### Other Installation Methods
- **Docker Compose** - Recommended for production deployments
- **Pre-built Binaries** - Available for Linux, macOS, and Windows
- **Kubernetes** - Helm charts and manifests available
- **Build from Source** - For development and customization
See our [installation guide](https://usememos.com/docs/deploy) for detailed instructions.
## Contributing ## Contributing
Contributions are welcome — bug reports, feature suggestions, pull requests, documentation, and translations. Contributions are welcome — bug reports, feature suggestions, pull requests, documentation, and translations.
- [Report bugs](https://github.com/usememos/memos/issues/new?template=bug_report.md)
- [Suggest features](https://github.com/usememos/memos/issues/new?template=feature_request.md)
- [Submit pull requests](https://github.com/usememos/memos/pulls)
- [Improve documentation](https://github.com/usememos/dotcom)
- [Help with translations](https://github.com/usememos/memos/tree/main/web/src/locales)
## Sponsors
Love Memos? [Sponsor us on GitHub](https://github.com/sponsors/usememos) to help keep the project growing!
## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=usememos/memos&type=Date)](https://star-history.com/#usememos/memos&Date)
## License ## License
Memos is open-source software licensed under the [MIT License](LICENSE). See our [Privacy Policy](https://usememos.com/privacy) for details on data handling. Canifa Note is based on Memos which is open-source software licensed under the [MIT License](LICENSE).
---
**[Website](https://usememos.com)****[Documentation](https://usememos.com/docs)****[Demo](https://demo.usememos.com/)****[Discord](https://discord.gg/tfPJa4UmAv)****[X/Twitter](https://x.com/usememos)**
<a href="https://vercel.com/oss">
<img alt="Vercel OSS Program" src="https://vercel.com/oss/program-badge.svg" />
</a>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment