Merge branch 'main' into kve/publish-da-pods

BlueprintUILists/Sources/Deprecations.swift

@@ -9,7 +9,7 @@ import BlueprintUI
 
 
 ///
-/// This file contains deprecations which have occurred in BlueprintLists, for which there are reasonable
+/// This file contains deprecations which have occurred in BlueprintUILists, for which there are reasonable
 /// forward-moving defaults (eg, renames), to ease transitions for consumers when they update their library version.
 ///
 /// To add new deprecations and changes:

BlueprintUILists/Sources/Exports.swift

@@ -6,7 +6,7 @@
 //
 
 ///
-/// Import required dependencies when using BlueprintLists.
+/// Import required dependencies when using BlueprintUILists.
 ///
 
 @_exported import BlueprintUI

CHANGELOG.md

@@ -192,7 +192,7 @@
 
 ### Changed
 
-- **Major Change:** `ItemElement` and `HeaderFooterElement` [were renamed to `ItemContent` and `HeaderFooterContent`](https://github.com/kyleve/Listable/pull/150), respectively. This is intended to be a clearer indicaton as to what they are for (the content of an item or header/footer), and fixes a name collision with Blueprint, where we overloaded the meaning of `Element` when using Blueprint integration via `BlueprintLists`.
+- **Major Change:** `ItemElement` and `HeaderFooterElement` [were renamed to `ItemContent` and `HeaderFooterContent`](https://github.com/kyleve/Listable/pull/150), respectively. This is intended to be a clearer indicaton as to what they are for (the content of an item or header/footer), and fixes a name collision with Blueprint, where we overloaded the meaning of `Element` when using Blueprint integration via `BlueprintUILists`.
 - Changed `BlueprintHeaderFooter{Content/Element}`'s main method to be `elementRepresentation` instead of `element`. This allows easier conformance of `BlueprintUI.ProxyElement` types to `BlueprintHeaderFooter{Content/Element}`.
 - `SelectionMode` [was moved from `Content` to `Behavior`](https://github.com/kyleve/Listable/pull/152), which is in line with other collection view behaviours like scrolling and underflow.
 - Rename `ItemSelectionStyle.none` to `ItemSelectionStyle.notSelectable`. This is to avoid conflicts with `Optional.none` when working with `ItemSelectionStyle` as an `Optional`.

ListableUI/Sources/ListActions.swift

@@ -11,7 +11,7 @@ import Foundation
 ///
 /// `ListActions` is an type that you can use to gain access to actions to perform on a `List`
 /// (for example, scrolling to a given item in the list) when used when you otherwise do
-/// not have a reference to the underlying list view (for example, when using `ListViewController` or `BlueprintLists`).
+/// not have a reference to the underlying list view (for example, when using `ListViewController` or `BlueprintUILists`).
 ///
 /// You also gain access to a `ListActions` instance when using `ListStateObserver`, in each registered callback.
 ///

ListableUI/Sources/ListProperties.swift

@@ -13,7 +13,7 @@ import Foundation
 /// and display a list on screen. It is usually used in declarative APIs which deal in descriptions of views
 /// (eg, Blueprint, SwiftUI, `ListViewController`) in place of referencing and managing a view directly.
 ///
-/// For example, in `BlueprintLists`, you create a Listable `List` element like so:
+/// For example, in `BlueprintUILists`, you create a Listable `List` element like so:
 /// ```
 /// List { list in
 ///     list.appearance = .myAppearance

ListableUI/Sources/ListViewController.swift

@@ -134,7 +134,7 @@ public extension ListView {
     /// 1) If subclassing `UIViewController`: within your view controller's `viewWillAppear` method.
     ///
     /// 2) By invoking this same method on your `ListActions` that you have wired up to your list view. Use this
-    /// in the case that you do not have access to your list view at all, such as when using `BlueprintLists`.
+    /// in the case that you do not have access to your list view at all, such as when using `BlueprintUILists`.
     ///
     /// // Behaviour from UIKit Eng: https://twitter.com/smileyborg/status/1279473615553982464
     ///

README.md

@@ -187,7 +187,7 @@ public enum Sizing : Equatable
 
 Listable integrates closely with [Blueprint](https://github.com/square/blueprint/), Square's framework for declarative UI construction and management (if you've used SwiftUI, Blueprint is similar). Listable provides wrapper types and default types to make using Listable lists within Blueprint elements simple, and to make it easy to build Listable items out of Blueprint elements.
 
-All you need to do is take a dependency on the `BlueprintLists` pod, and then `import BlueprintUILists` to begin using Blueprint integration.
+All you need to do is take a dependency on the `BlueprintUILists` pod, and then `import BlueprintUILists` to begin using Blueprint integration.
 
 In this example, we see how to declare a `List` within a Blueprint element hierarchy.
 
@@ -558,7 +558,7 @@ public struct Section
 
 ## Integration With Blueprint
 
-If you're using Blueprint integration via the  `BlueprintLists` module, you will also interact with the following types.
+If you're using Blueprint integration via the  `BlueprintUILists` module, you will also interact with the following types.
 
 ### List
 When using `ListView` directly, you'd use `list.configure { list in ... }` to set the content of a list.
@@ -657,18 +657,18 @@ struct MyHeader : BlueprintHeaderFooterContent, Equatable
 
 ## Getting Started
 
-Listable can be consumed via CocoaPods. Add one or both of these lines to your `Podfile` in order to consume Listable and BlueprintLists (the Blueprint wrapper for Listable).
+Listable is published on CocoaPods. You can add a dependency on Listable or it's Blueprint wrapper with the following in your Podspec: 
 
 ```
-  pod 'BlueprintLists', git: 'ssh://[email protected]:kyleve/Listable.git'
-  pod 'Listable', git: 'ssh://[email protected]:kyleve/Listable.git'
+s.dependency 'ListableUI'
+s.dependency 'BlueprintUILists'
 ```
 
-You can then add the following to each `podspec` which should depend on Listable.
+If you want to depend on bleeding-edge changes, you can add the pods to your Podfile via the git repo like so:
 
 ```
-s.dependency 'Listable'
-s.dependency 'BlueprintLists'
+  pod 'BlueprintUILists', git: 'ssh://[email protected]:kyleve/Listable.git'
+  pod 'ListableUI', git: 'ssh://[email protected]:kyleve/Listable.git'
 ```
 
 ## Demo Project