Browse Source

updating quick start

Anatoly Pulyaevskiy 5 years ago
parent
commit
4559b766a9
2 changed files with 29 additions and 0 deletions
  1. 2
    0
      SUMMARY.md
  2. 27
    0
      doc/release-notes.md

+ 2
- 0
SUMMARY.md View File

1
 # Summary
1
 # Summary
2
 
2
 
3
+* [Release Notes](doc/release-notes.md)
4
+  * [Zefyr Changelog](packages/zefyr/CHANGELOG.md)
3
 * [Quick Start](doc/quick-start.md)
5
 * [Quick Start](doc/quick-start.md)
4
 * [Concepts](doc/concepts/readme.md)
6
 * [Concepts](doc/concepts/readme.md)
5
   * [Data Format and Document Model](doc/concepts/data-and-document.md)
7
   * [Data Format and Document Model](doc/concepts/data-and-document.md)

+ 27
- 0
doc/release-notes.md View File

1
+# Release notes
2
+
3
+Current version of Zefyr editor is `0.7` ([changelog](packages/zefyr/CHANGELOG.md)).
4
+
5
+### 0.7
6
+
7
+__This is a breaking change release.__
8
+
9
+This version introduces first set of changes aimed at addressing some
10
+common pain points reported by users of this library. In addition this release
11
+is the first step towards making Zefyr easier to extend and customize.
12
+
13
+This version of Zefyr also comes with revamped documentation website and
14
+some of the articles completely rewritten to help new users to get started. More
15
+articles and tutorials will be added in future releases.
16
+
17
+Highlights of this release include:
18
+
19
+* Zefyr no longer depends in `image_picker` package. This introduced breaking
20
+  changes described in the changelog.
21
+* Selection overlay has been refactored to enable customization work in
22
+  follow up releases.
23
+* Zefyr now supports selection-only workflow via new `ZefyrMode` object which
24
+  replaces previous `enabled` field (breaking change).
25
+
26
+For more details on breaking changes and upgrade instructions please read
27
+[changelog](packages/zefyr/CHANGELOG.md).