From 095d6b74114cbb9e125eca44cea33ac8b1d38ceb Mon Sep 17 00:00:00 2001 From: Jesse Squires Date: Mon, 1 Jul 2024 14:57:34 -0700 Subject: [PATCH] [0.1.1] documentation updates --- CHANGELOG.md | 10 ++++++++++ README.md | 5 +++-- docs/Classes.html | 2 +- docs/Classes/CollectionViewDriver.html | 2 +- docs/Enums.html | 2 +- docs/Enums/ViewRegistrationMethod.html | 2 +- docs/Enums/ViewRegistrationViewType.html | 2 +- docs/Extensions.html | 2 +- docs/Extensions/UICollectionView.html | 2 +- docs/Protocols.html | 2 +- docs/Protocols/CellEventCoordinator.html | 2 +- docs/Protocols/CellViewModel.html | 2 +- docs/Protocols/DiffableViewModel.html | 2 +- docs/Protocols/SupplementaryFooterViewModel.html | 2 +- docs/Protocols/SupplementaryHeaderViewModel.html | 2 +- docs/Protocols/SupplementaryViewModel.html | 2 +- docs/Protocols/ViewRegistrationProvider.html | 2 +- docs/Structs.html | 2 +- docs/Structs/AnyCellViewModel.html | 2 +- docs/Structs/AnySupplementaryViewModel.html | 2 +- docs/Structs/CollectionViewDriverOptions.html | 2 +- docs/Structs/CollectionViewModel.html | 2 +- docs/Structs/EmptyViewProvider.html | 2 +- docs/Structs/SectionViewModel.html | 2 +- docs/Structs/ViewRegistration.html | 2 +- docs/Typealiases.html | 2 +- docs/index.html | 12 +++++++++--- 27 files changed, 46 insertions(+), 29 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cd7288f..0510935 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,16 @@ The changelog for `ReactiveCollectionsKit`. Also see [the releases on GitHub](https://github.com/jessesquires/ReactiveCollectionsKit/releases). +NEXT +----- + +- TBA + +0.1.1 +----- + +Documentation updates. + 0.1.0 ----- diff --git a/README.md b/README.md index 1a3cd3c..fa0c698 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ This library contains a number of improvements, optimizations, and refinements o ---|---------------- 🏛️ | Declarative, data-driven architecture with reusable components 🔐 | Immutable, uni-directional data flow +🔀 | Safe from data races with Swift 6 strict concurrency checking 🤖 | Automatic diffing for cells, sections, and supplementary views 🎟️ | Automatic registration and dequeuing for cells and supplementary views 📐 | Automatic self-sizing cells and supplementary views @@ -88,8 +89,8 @@ driver.update(viewModel: updated) ## Requirements - iOS 15.0+ -- Swift 5.9+ -- Xcode 15.0+ +- Swift 5.10+ +- Xcode 15.4+ - [SwiftLint](https://github.com/realm/SwiftLint) ## Installation diff --git a/docs/Classes.html b/docs/Classes.html index 4e3d6e1..e1b7d84 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -178,7 +178,7 @@

Declaration

diff --git a/docs/Classes/CollectionViewDriver.html b/docs/Classes/CollectionViewDriver.html index 93819da..eb16f08 100644 --- a/docs/Classes/CollectionViewDriver.html +++ b/docs/Classes/CollectionViewDriver.html @@ -642,7 +642,7 @@

Parameters

diff --git a/docs/Enums.html b/docs/Enums.html index c15746e..09a5758 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -202,7 +202,7 @@

Declaration

diff --git a/docs/Enums/ViewRegistrationMethod.html b/docs/Enums/ViewRegistrationMethod.html index c810bed..7f541b0 100644 --- a/docs/Enums/ViewRegistrationMethod.html +++ b/docs/Enums/ViewRegistrationMethod.html @@ -209,7 +209,7 @@

Declaration

diff --git a/docs/Enums/ViewRegistrationViewType.html b/docs/Enums/ViewRegistrationViewType.html index 5fcc854..b4ae417 100644 --- a/docs/Enums/ViewRegistrationViewType.html +++ b/docs/Enums/ViewRegistrationViewType.html @@ -209,7 +209,7 @@

Declaration

diff --git a/docs/Extensions.html b/docs/Extensions.html index c9b0923..0d743ec 100644 --- a/docs/Extensions.html +++ b/docs/Extensions.html @@ -199,7 +199,7 @@

Declaration

diff --git a/docs/Extensions/UICollectionView.html b/docs/Extensions/UICollectionView.html index c17a161..efb0e0f 100644 --- a/docs/Extensions/UICollectionView.html +++ b/docs/Extensions/UICollectionView.html @@ -200,7 +200,7 @@

Parameters

diff --git a/docs/Protocols.html b/docs/Protocols.html index 7f2805f..679736a 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -351,7 +351,7 @@

Declaration

diff --git a/docs/Protocols/CellEventCoordinator.html b/docs/Protocols/CellEventCoordinator.html index 930b6b9..1e6ea34 100644 --- a/docs/Protocols/CellEventCoordinator.html +++ b/docs/Protocols/CellEventCoordinator.html @@ -295,7 +295,7 @@

Declaration

diff --git a/docs/Protocols/CellViewModel.html b/docs/Protocols/CellViewModel.html index 823b37d..eb69eb0 100644 --- a/docs/Protocols/CellViewModel.html +++ b/docs/Protocols/CellViewModel.html @@ -484,7 +484,7 @@

Declaration

diff --git a/docs/Protocols/DiffableViewModel.html b/docs/Protocols/DiffableViewModel.html index 2e2c017..be1ba58 100644 --- a/docs/Protocols/DiffableViewModel.html +++ b/docs/Protocols/DiffableViewModel.html @@ -183,7 +183,7 @@

Declaration

diff --git a/docs/Protocols/SupplementaryFooterViewModel.html b/docs/Protocols/SupplementaryFooterViewModel.html index ce03501..3c52c7f 100644 --- a/docs/Protocols/SupplementaryFooterViewModel.html +++ b/docs/Protocols/SupplementaryFooterViewModel.html @@ -227,7 +227,7 @@

Declaration

diff --git a/docs/Protocols/SupplementaryHeaderViewModel.html b/docs/Protocols/SupplementaryHeaderViewModel.html index 1962133..bea8de9 100644 --- a/docs/Protocols/SupplementaryHeaderViewModel.html +++ b/docs/Protocols/SupplementaryHeaderViewModel.html @@ -227,7 +227,7 @@

Declaration

diff --git a/docs/Protocols/SupplementaryViewModel.html b/docs/Protocols/SupplementaryViewModel.html index ec1d02d..e247712 100644 --- a/docs/Protocols/SupplementaryViewModel.html +++ b/docs/Protocols/SupplementaryViewModel.html @@ -320,7 +320,7 @@

Declaration

diff --git a/docs/Protocols/ViewRegistrationProvider.html b/docs/Protocols/ViewRegistrationProvider.html index 46f86bd..7c446d0 100644 --- a/docs/Protocols/ViewRegistrationProvider.html +++ b/docs/Protocols/ViewRegistrationProvider.html @@ -183,7 +183,7 @@

Declaration

diff --git a/docs/Structs.html b/docs/Structs.html index 66529b9..337183a 100644 --- a/docs/Structs.html +++ b/docs/Structs.html @@ -370,7 +370,7 @@

Declaration

diff --git a/docs/Structs/AnyCellViewModel.html b/docs/Structs/AnyCellViewModel.html index 78cc8b6..6e925e6 100644 --- a/docs/Structs/AnyCellViewModel.html +++ b/docs/Structs/AnyCellViewModel.html @@ -220,7 +220,7 @@

Parameters

diff --git a/docs/Structs/AnySupplementaryViewModel.html b/docs/Structs/AnySupplementaryViewModel.html index 8adf761..26fe111 100644 --- a/docs/Structs/AnySupplementaryViewModel.html +++ b/docs/Structs/AnySupplementaryViewModel.html @@ -220,7 +220,7 @@

Parameters

diff --git a/docs/Structs/CollectionViewDriverOptions.html b/docs/Structs/CollectionViewDriverOptions.html index 94bf02d..964552f 100644 --- a/docs/Structs/CollectionViewDriverOptions.html +++ b/docs/Structs/CollectionViewDriverOptions.html @@ -277,7 +277,7 @@

Parameters

diff --git a/docs/Structs/CollectionViewModel.html b/docs/Structs/CollectionViewModel.html index edbd868..46b8124 100644 --- a/docs/Structs/CollectionViewModel.html +++ b/docs/Structs/CollectionViewModel.html @@ -837,7 +837,7 @@

Return Value

diff --git a/docs/Structs/EmptyViewProvider.html b/docs/Structs/EmptyViewProvider.html index aef9c85..e1ab895 100644 --- a/docs/Structs/EmptyViewProvider.html +++ b/docs/Structs/EmptyViewProvider.html @@ -256,7 +256,7 @@

Parameters

diff --git a/docs/Structs/SectionViewModel.html b/docs/Structs/SectionViewModel.html index 7d58b64..5f023a9 100644 --- a/docs/Structs/SectionViewModel.html +++ b/docs/Structs/SectionViewModel.html @@ -1034,7 +1034,7 @@

Return Value

diff --git a/docs/Structs/ViewRegistration.html b/docs/Structs/ViewRegistration.html index 3290dfa..0052d9a 100644 --- a/docs/Structs/ViewRegistration.html +++ b/docs/Structs/ViewRegistration.html @@ -567,7 +567,7 @@

Parameters

diff --git a/docs/Typealiases.html b/docs/Typealiases.html index ae69d4d..d00fb99 100644 --- a/docs/Typealiases.html +++ b/docs/Typealiases.html @@ -200,7 +200,7 @@

Declaration

diff --git a/docs/index.html b/docs/index.html index c351dba..c9ff428 100644 --- a/docs/index.html +++ b/docs/index.html @@ -134,6 +134,8 @@

ReactiveCollectionsKit CI

+

+

Data-driven, declarative, reactive, diffable collections (and lists!) for iOS. A modern, fast, and flexible library for UICollectionView done right.

About

@@ -160,6 +162,10 @@

Main Features

Immutable, uni-directional data flow +🔀 +Safe from data races with Swift 6 strict concurrency checking + + 🤖 Automatic diffing for cells, sections, and supplementary views @@ -270,8 +276,8 @@

Requirements

Installation

@@ -422,7 +428,7 @@

License