Skip to content

Commit

Permalink
chore: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Novout committed Apr 13, 2022
1 parent d0d9c9c commit e58ddad
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 141 deletions.
Binary file added .github/entitymodel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
135 changes: 0 additions & 135 deletions FEATURES.md

This file was deleted.

36 changes: 30 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,45 @@ A Modern Word Processor
<a href="https://better-write.vercel.app"><img src="https://img.shields.io/github/lerna-json/v/Novout/better-write?style=for-the-badge&color=0f172a&label="></a>
<p>

<br>
<br>

> WARNING: Early stage of development and is not recommended for use in production.
# Features

- ✅ Entity-Model Editor
- ✅ Offline First
- ✅ Cloud Save
- ✅ Full Customization
- ✅ Multipurpose
- ✅ High Tracking
- ✅ Statistics in Real-Time
- ✅ Graph Control
- ✅ Plugin Friendly
- ✅ Mobile & Desktop (PWA)
- ✅ PDF - DOCX Generator
- ✅ PDF, DOCX, TXT Generator

# Motivation

There are no word processors on the market that are not inextricable from the context itself.
__Better Write__ offers an individual and reactive approach to any item that is entered in the editor.

<br>

<p align="center">
<img src="./.github/example.png" width="100%" />
<p>

[DEMO HERE](https://better-write.vercel.app)
<br>

## Entity Model

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.

<br>

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

<br>

Check all features [here](./FEATURES.md)
# Changelog

Check changelog [here](./CHANGELOG.md)
Check changelog [here](./CHANGELOG.md)

0 comments on commit e58ddad

Please sign in to comment.