Skip to content

Commit

Permalink
chore: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Novout committed Jun 13, 2023
1 parent 8cb4232 commit 30951d8
Show file tree
Hide file tree
Showing 11 changed files with 11 additions and 21 deletions.
Binary file removed .github/annotations.png
Binary file not shown.
Binary file removed .github/canvasmodel.png
Binary file not shown.
Binary file removed .github/characters1.png
Binary file not shown.
Binary file removed .github/entity.gif
Binary file not shown.
Binary file removed .github/entitymodel.png
Binary file not shown.
Binary file added .github/main2.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed .github/pdf.png
Binary file not shown.
Binary file removed .github/statistics.png
Binary file not shown.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@ betterwrite.io

<br>

<a href="https://betterwrite.io/">
<img src="./.github/main.png" width="100%" />
</a>
<p align="center">
<a href="https://betterwrite.io/">
<img src="./.github/main.png" width="90%" />
</a>
<p>

# Features

Expand All @@ -42,7 +44,11 @@ betterwrite.io

# An Editor for Creative Writing

Unlike traditional word processors, *betterwrite* focuses on producing an out-of-the-curve experience for writers and writing derivatives, bringing with it several additional tools to increase the flow of use:
Unlike traditional word processors, *betterwrite* focuses on producing an out-of-the-curve experience for writers and writing derivatives, bringing with it several additional tools to increase the flow of use.

<p align="center">
<img src="./.github/main2.gif" width="90%" />
<p>

- **Full Customization**: The editor is fully customizable with the main focus on emphasizing the writer's creativity and adapting all the context at his disposal. In addition to standard themes, *betterwrite* allows for custom backgrounds (including *gifs*) and the use of external fonts within the editor itself.

Expand Down
12 changes: 0 additions & 12 deletions docs/ENTITY_MODEL.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,6 @@

Better Write works with the Entity Model, where each item in the editor is unique and independent of other content. This model allows the creation of resources that do not necessarily function as texts, such as Lists, Checkboxes, Images and Drawings. The generators do not need to extract data from the editor because with the Entity Model we can standardize the project data, allowing the extensions (.PDF, .DOCX, .HTML, .TXT) to work independently and a new external extensions support.

## Comparison

<img src="../.github/entity.gif" />

- Canvas Model (Common in other Word Processors)

<img src="../.github/canvasmodel.png" width="50%" />

- Entity Model

<img src="../.github/entitymodel.png" width="50%" />

## Contenteditable

To more easily deal with the issue of data entry (mainly keyboard related) it was necessary to create a specific package (better-write-contenteditable-ast) to deal only with the editor and provide what is necessary for the tools that depend on it (eg document exporters). The contenteditable is an html helper that allows you to treat a specific tag as editable (similar to input). The great advantage is its adaptability and the possibility of control that the tool provides, allowing you to browse the AST in a more coherent way (and without worrying about errors in italics, for example).
Expand Down
6 changes: 1 addition & 5 deletions docs/GENERATOR_FLOW.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,4 @@ Custom types that are not traditionally text or images depend on whether the doc

> The TXT text generator fails to convert the vast majority of blocks, discarding all non-text entity types.
> Which features the word processor supports by each extension can be found in the **Help -> Questions** section.
## Customization

<img src="../.github/pdf.png" />
> Which features the word processor supports by each extension can be found in the **Help -> Questions** section.

0 comments on commit 30951d8

Please sign in to comment.