From 19fcd77938c25f085f3601461a657e776b042f90 Mon Sep 17 00:00:00 2001 From: Annie Date: Tue, 7 Jan 2025 14:28:42 +0800 Subject: [PATCH] Update README.md batch 2 Added more sections: - Installation - Built with - Translations - Use cases - License --- README.md | 37 ++++++++++++++++++++++++++++++++++--- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4c72458a..9174532b 100644 --- a/README.md +++ b/README.md @@ -24,18 +24,49 @@ Bring projects, wikis, and teams together with AI ![appflowy_web_quick_note_large](https://github.com/user-attachments/assets/5c633e60-6f34-454c-91db-236a1b78966a) ![appflowy_web_share](https://github.com/user-attachments/assets/64b9955d-b11f-4aa1-b32b-ea79ea7f3566) +## Use cases +- Build and maintain a knowledge base for your team +- Create and publish documentation for your customers and audience +- Write, publish, and manage content with AI +- Manage tasks and projects for yourself and your team + ## Features - Write beautiful documents with rich content types - Add a Quick Note to jot down lists, ideas, or to-dos - Invite members to your workspace for seamless collaboration - Create multiple public and private spaces to better organize your content -## AppFlowy Web Roadmap -Features listed below are available in AppFlowy desktop and mobile applications (Download). +## AppFlowy Web roadmap +>Features listed below are available in AppFlowy desktop and mobile applications (Download). + +Q1 2025: - Search, publish pages, templates - Favorte pages - More document features incl. simple table and column layout - AI Chat and AI Writer ## Installation -WIP +### Cloud: we host AppFlowy for you +Sign up for a free account on appflowy.comβ€”it's the fastest way to get started with AppFlowy without hassles + +### Self-hosted: host AppFlowy on your own server +Take charge of your data; no vendor lock-in. Follow our deployment guide (WIP) to get started. +Join our Discord server to get help! + +## Built with πŸ› οΈ +![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB) +![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white) +![Bun](https://img.shields.io/badge/Bun-000000?style=for-the-badge&logo=bun&logoColor=white) +![Nginx](https://img.shields.io/badge/Nginx-009639?style=for-the-badge&logo=nginx&logoColor=white) +![Docker](https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white) + +## Translations πŸŒŽπŸ—Ί +[![translation badge](https://inlang.com/badge?url=github.com/AppFlowy-IO/AppFlowy)](https://inlang.com/editor/github.com/AppFlowy-IO/AppFlowy?ref=badge) + +To add translations, you can manually edit the JSON translation files in `/frontend/resources/translations`, use +the [inlang online editor](https://inlang.com/editor/github.com/AppFlowy-IO/AppFlowy), or +run `npx inlang machine translate` to add missing translations. + +## License +Distributed under the AGPLv3 License. See [`LICENSE.md`](https://github.com/AppFlowy-IO/AppFlowy-Web/blob/main/LICENSE) for +more information.