From ee715ab74af76a5fe5f6f51c900343c21d258abf Mon Sep 17 00:00:00 2001 From: Takeshi Shimada Date: Mon, 27 Oct 2025 02:11:03 +0900 Subject: [PATCH] docs: Reduce redundant expressions in English documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Update version from 0.1.6 to 1.0.0 in GettingStarted.md - Simplify opening description for better readability - Change "Reduced code" to "Less boilerplate code" for clarity - Remove duplicate "Caught at compile time" bullet point - Consolidate middleware description into single sentence - Simplify "Use for" to more direct phrasing These changes improve documentation clarity without changing technical accuracy or meaning. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- README.md | 9 ++++----- Sources/Flow/Flow.docc/GettingStarted.md | 4 ++-- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5c5d147..82d9e76 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Platforms](https://img.shields.io/badge/Platforms-iOS%20|%20macOS%20|%20watchOS%20|%20tvOS-blue.svg)](https://github.com/ViewFeature/Flow) [![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) -A library for managing state in SwiftUI applications in a type-safe way. Flow provides a unidirectional data flow architecture with full support for Swift 6 Approachable Concurrency. +A type-safe state management library for SwiftUI applications. Flow provides a unidirectional data flow architecture with full support for Swift 6 Approachable Concurrency.

Flow Architecture Diagram @@ -171,7 +171,7 @@ final class State { ``` - No Combine dependency -- Reduced code +- Less boilerplate code - Integrates with SwiftUI's standard APIs ### Approachable Concurrency @@ -205,11 +205,10 @@ func handle() -> ActionHandler { - Thread-safety guaranteed - Native `async/await` support - Direct state mutations in `.run` blocks -- Caught at compile time, not runtime ### Observable Actions -Flow uses **middleware** to observe actions. This enables implementing cross-cutting concerns like logging, analytics, and debugging. +Flow uses **middleware** to observe actions, enabling cross-cutting concerns like logging, analytics, and debugging. ```swift struct AnalyticsMiddleware: BeforeActionMiddleware { @@ -231,7 +230,7 @@ func handle() -> ActionHandler { ``` - Observe all actions in one place -- Use for logging, analytics, and debugging +- Logging, analytics, and debugging support ## Documentation diff --git a/Sources/Flow/Flow.docc/GettingStarted.md b/Sources/Flow/Flow.docc/GettingStarted.md index 7c5f99f..e2d0384 100644 --- a/Sources/Flow/Flow.docc/GettingStarted.md +++ b/Sources/Flow/Flow.docc/GettingStarted.md @@ -19,7 +19,7 @@ Add Flow to your `Package.swift`: ```swift dependencies: [ - .package(url: "https://github.com/ViewFeature/Flow.git", from: "0.1.6") + .package(url: "https://github.com/ViewFeature/Flow.git", from: "1.0.0") ] ``` @@ -41,7 +41,7 @@ dependencies: [ 1. Select **File → Add Package Dependencies** 2. Enter the URL: `https://github.com/ViewFeature/Flow.git` -3. Select version: `0.1.6` or later +3. Select version: `1.0.0` or later 4. Add to your target's **Build Settings → Other Swift Flags**: `-default-isolation MainActor` ## Build a Counter App