Browse Source

doc updates

Anatoly Pulyaevskiy 5 years ago
parent
commit
cd03fc8b8f
2 changed files with 9 additions and 13 deletions
  1. 3
    1
      README.md
  2. 6
    12
      doc/quick-start.md

+ 3
- 1
README.md View File

@@ -1,4 +1,6 @@
1
-# Zefyr [![Build Status](https://travis-ci.com/memspace/zefyr.svg?branch=master)](https://travis-ci.com/memspace/zefyr) [![codecov](https://codecov.io/gh/memspace/zefyr/branch/master/graph/badge.svg)](https://codecov.io/gh/memspace/zefyr)
1
+# About Zefyr
2
+
3
+[![Build Status](https://travis-ci.com/memspace/zefyr.svg?branch=master)](https://travis-ci.com/memspace/zefyr) [![codecov](https://codecov.io/gh/memspace/zefyr/branch/master/graph/badge.svg)](https://codecov.io/gh/memspace/zefyr)
2 4
 
3 5
 *Soft and gentle rich text editing for Flutter applications.*
4 6
 

+ 6
- 12
doc/quick-start.md View File

@@ -2,10 +2,8 @@
2 2
 
3 3
 Zefyr project consists of two packages:
4 4
 
5
-1. [zefyr](https://pub.dev/packages/zefyr) - Flutter package which provides
6
-   the UI part.
7
-2. [notus](https://pub.dev/packages/notus) - platform-agnostic package which
8
-   provides document model used in Zefyr editor.
5
+1. [zefyr](https://pub.dev/packages/zefyr) - Flutter package which provides the UI part.
6
+2. [notus](https://pub.dev/packages/notus) - platform-agnostic package which provides document model used in Zefyr editor.
9 7
 
10 8
 ### Installation
11 9
 
@@ -23,17 +21,13 @@ and `notus` packages.
23 21
 
24 22
 There are 4 main objects you would normally interact with in your code:
25 23
 
26
-* `NotusDocument`, represents a rich text document and provides
27
-  high-level methods for manipulating the document's state, like
28
-  inserting, deleting and formatting of text.
29
-  Read [documentation](concepts/data-and-document.md) for more details on Notus
30
-  document model and data format.
31
-* `ZefyrEditor`, a Flutter widget responsible for rendering of rich text
32
-  on the screen and reacting to user actions.
24
+* `NotusDocument`, represents a rich text document and provides high-level methods for manipulating the document's state, like inserting, deleting and formatting of text. Read [documentation](concepts/data-and-document.md) for more details on Notus document model and data format.
25
+* `ZefyrEditor`, a Flutter widget responsible for rendering of rich text on the screen and reacting to user actions.
33 26
 * `ZefyrController`, ties the above two objects together.
34 27
 * `ZefyrScaffold`, allows embedding Zefyr toolbar into any custom layout.
35 28
 
36
-`ZefyrEditor` depends on presence of `ZefyrScaffold` somewhere up the widget tree.
29
+Note that `ZefyrEditor` depends on presence of `ZefyrScaffold` somewhere up the
30
+widget tree.
37 31
 
38 32
 Normally you would need to place `ZefyrEditor` inside of a
39 33
 `StatefulWidget`. Shown below is a minimal setup required to use the