mirror of
https://github.com/toeverything/AFFiNE.git
synced 2026-02-11 11:58:41 +00:00
Refactor: whole README remastered
This commit is contained in:
57
README.md
57
README.md
@@ -41,11 +41,13 @@ With affine, every page comes with 2 views, and you can access and edit fully fu
|
||||
## Plan your task
|
||||
We really appreciate the idea of monday, airtable and notion database. They inspired what we think is right for task management. But we don't like the repeated works -- we don't want to set a todo easily with markdown but end up re-write it again in kanban or other databases.
|
||||
With affine, every block group has infinite views, for you to keep your single source of truth.
|
||||

|
||||
|
||||
## Sort your knowledge
|
||||
A good, semantic knowledge base is made of reusable, linked elements. Affine is completely made on top of the idea of blocks. Blocks can be 2-way linked, duplicated, reused and synced between docs.
|
||||
Rich-text paragraphs are blocks. Images are blocks. Todos are blocks and quotes are blocks. You can assemble blocks to form a bigger block, and you can even embed another as a block!
|
||||
As semantic web lovers, we don't like the idea of folders that much, and we make everything easy to find.
|
||||

|
||||
|
||||
## Create your story
|
||||
We want your data always to be yours, and we don't want to make any sacrifice to your accessibility. Your data is always local-stored first, yet we support real-time collaboration on a peer-to-peer basis. We don't think "privacy-first" is a good excuse for not supporting modern web features.
|
||||
@@ -62,9 +64,62 @@ Built With
|
||||
Getting Started with development
|
||||
Please view the documentation for OS specific development instructions
|
||||
|
||||
# User Installation
|
||||
Please view the documentation for OS specific installation instructions.
|
||||
|
||||
## Installation
|
||||
# Built With
|
||||
- Typescript
|
||||
- Rust
|
||||
- React
|
||||
|
||||
# Getting Started with development
|
||||
Please view the documentation for OS specific development instructions
|
||||
|
||||
# Roadmap
|
||||
Coming Soon...
|
||||
|
||||
# Feature requests
|
||||
Please go to : https://github.com/toeverything/AFFiNE/issues
|
||||
|
||||
# FAQ
|
||||
Please go to https://www.reddit.com/r/Affine/
|
||||
|
||||
|
||||
# The Philosophy of AFFiNE
|
||||
Timothy Berners-Lee once taught us about the idea of the semantic web, where all the data can be interpreted in any form while the "truth" is kept. This gives our best image of an ideal knowledge base by far, that sorting of information, planning of project and goals as well as creating of knowledge can be all together.
|
||||
We have witnessed waves of paradigm shift so many times. At first, everything was noted on office-like apps or DSL like LaTeX, then we found todo-list apps and WYSIWYG markdown editors better for writing and planning. Finally, here comes Notion and Miro, who take advantage of the idea of blocks to further liberate our creativity.
|
||||
It is all perfect... If there are not so many waste operations and redundant information. And, we insist that privacy first should always be given by default.
|
||||
That's why we are making AFFiNE. Some of the most important features are:
|
||||
- Transformable
|
||||
- Every block can be transformed equally as a database
|
||||
- e.g. you can now set up a to-do with MarkDown in text view and edit it in kanban view.
|
||||
- Every doc can be turned into a whiteboard
|
||||
- An always good-to-read, structured docs-form page is the best for your notes, but a boundless doodle surface is better for collaboration and creativity.
|
||||
- Atomic
|
||||
- The basic element of affine are blocks, not pages.
|
||||
- Blocks can be directly reuse and synced between pages.
|
||||
- Pages and blocks are searched and organized on the basis of connected graphs, not tree-like paths.
|
||||
- Dual-link and semantic search are fully supported.
|
||||
- Collaborative and privacy-first
|
||||
- Data is always stored locally by default
|
||||
- CRDTs are applied so that peer-to-peer collaboration is possible.
|
||||
|
||||
We really appreciate the idea of Monday, airtable and notion database. They inspired what we think is right for task management. But we don't like the repeated works -- we don't want to set a todo easily with markdown but end up re-write it again in kanban or other databases.
|
||||
With AFFiNE, every block group has infinite views, for you to keep your single source of truth.
|
||||
|
||||
We would like to give special thanks to the innovators and pioneers who greatly inspired us:
|
||||
- Quip & Notion -- that docs can be organized as blocks
|
||||
- Taskade & Monday -- brillant multi-demensional tables
|
||||
- Height & Linear -- beautiful task management tool
|
||||
|
||||
We would also like to give thanks to open-source projects that make affine possible:
|
||||
- Yjs & Yrs
|
||||
- React
|
||||
- Rust
|
||||
|
||||
|
||||
# Installation
|
||||
Please view the documentation for OS specific installation instructions.
|
||||
```sh
|
||||
# Clone the repo
|
||||
git clone git@github.com:toeverything/AFFiNE.git
|
||||
|
||||
Reference in New Issue
Block a user