From f59f4451b9bf56c12b58f9c43aecb1773f21b0e4 Mon Sep 17 00:00:00 2001 From: Amy Worrall Date: Wed, 5 Jul 2023 11:58:40 -0700 Subject: [PATCH] Changelog for 0.1 release (#28) Summary: Changelog for 0.1 release Pull Request resolved: https://github.com/facebook/lexical-ios/pull/28 Reviewed By: zurfyx Differential Revision: D47233570 Pulled By: amyworrall fbshipit-source-id: ee6f5aea9e0a5f2a018181e8300b334f3a2c78f7 --- Lexical/Documentation.docc/Changelog.md | 23 +++++++++++++++++++++++ Lexical/Documentation.docc/Lexical.md | 4 ++++ README.md | 10 ++++++---- 3 files changed, 33 insertions(+), 4 deletions(-) create mode 100644 Lexical/Documentation.docc/Changelog.md diff --git a/Lexical/Documentation.docc/Changelog.md b/Lexical/Documentation.docc/Changelog.md new file mode 100644 index 0000000..732edc6 --- /dev/null +++ b/Lexical/Documentation.docc/Changelog.md @@ -0,0 +1,23 @@ +# Changelog + +This document lists changes made in each released version of Lexical. + +## 0.1 (Wed 5th July 2023) + +- Initial release +- Features + - Lexical API re-implemented in Swift + - ``LexicalView``, a rich text editor for use within UIKit + - An example Playground app, containing a sample implementation of a rich text toolbar + - JSON serialization + - HTML export (work in progress) + - Decorator node API allows embedding inline `UIView`s that move with the text + - Embedded inline images + - Bulleted and numbered lists + - Theming support based on NSAttributedString attributes + - Plugin interface, including commands, listeners, and custom drawing routines + - A read-only Lexical renderer ``LexicalReadOnlyView`` (currently undocumented) + - Initial read-only support for tables + +- A note on API stability + - For versions before we hit `1.0`, any breaking changes of the API will be accompanied by an increase in the second version digit. For example, a `0.1.1` release will not contain breaking API changes (although it may contain API additions); whereas a `0.2` release may contain breaking changes. We will attempt to mention any such changes in the release notes. diff --git a/Lexical/Documentation.docc/Lexical.md b/Lexical/Documentation.docc/Lexical.md index f72c4db..1f64d57 100644 --- a/Lexical/Documentation.docc/Lexical.md +++ b/Lexical/Documentation.docc/Lexical.md @@ -4,6 +4,10 @@ Lexical for iOS is an extensible text rendering and editing framework written in ## Topics +### Releases + +- + ### Articles - diff --git a/README.md b/README.md index 2bfc44e..02c3d42 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,9 @@ An extensible text editor/renderer written in Swift, built on top of TextKit, an Lexical iOS is used in multiple apps at Meta, including rendering feed posts that contain inline images in Workplace iOS. -As of March 2023, the date of our initial open source release, Lexical iOS should be treated as an unsupported preview version. We have not established a version numbering or release cadence yet; it is expected our first 'release' will be numbered 0.1. +Lexical iOS is in pre-release with no guarantee of support. + +For changes between versions, see the [Lexical iOS Changelog](https://github.com/facebook/lexical-ios/blob/main/Lexical/Documentation.docc/Changelog.md). ## Playground @@ -19,12 +21,12 @@ The playground app contains the code for a rich text toolbar. While this is not This playground app is very new, and many more features will come in time! ## Requirements -Lexical iOS is written in Swift, and targets iOS 13 and above. +Lexical iOS is written in Swift, and targets iOS 13 and above. (Note that the Playground app requires at least iOS 14, due to use of UIKit features such as UIMenu.) ## Building Lexical We provide a Swift package file that is sufficient to build Lexical core. Add this as a dependency of your app to use Lexical. -The plugins included in this repository do not yet have package files. (This is because we use a different build system internally at Meta. Adding these would be an easy PR if you want to start contributing to Lexical!) +Some plugins included in this repository do not yet have package files. (This is because we use a different build system internally at Meta. Adding these would be an easy PR if you want to start contributing to Lexical!) ## Using Lexical in your app For editable text with Lexical, instantiate a `LexicalView`. To configure it with plugins and a theme, you can create an `EditorConfig` to pass in to the `LexicalView`'s initialiser. @@ -37,7 +39,7 @@ For more information, see the documentation. Read [the Lexical iOS documentation](https://facebook.github.io/lexical-ios/documentation/lexical/). ## Join the Lexical community -Feel free to join us at [our Discord server](https://discord.gg/KmG4wQnnD9), where you can talk with the Lexical team and other users. +Join us at [our Discord server](https://discord.gg/KmG4wQnnD9), where you can talk with the Lexical team and other users. See the [CONTRIBUTING](CONTRIBUTING.md) file for how to help out.