Skip to content

Commit db39e2b

Browse files
authored
Merge pull request #173 from yumemi-inc/update_readme
Update README
2 parents 487a619 + 68215d3 commit db39e2b

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Key benefits:
2222
- Because state is immutable during processing, you don’t have to worry about side effects.
2323
- Code becomes more declarative.
2424
- Writing tests is straightforward.
25+
- The state-machine-oriented DSL keeps state transitions explicit and readable.
2526
- Works across multiple platforms.
2627
- Enables code sharing and consistent logic across platforms.
2728

@@ -32,11 +33,20 @@ The architecture is inspired by [Flux](https://facebookarchive.github.io/flux/)
3233
</div>
3334
</br>
3435

35-
Especially, Tart is particularly strong in applications with multiple explicit states.
36-
By combining Tart with Kotlin `sealed class`/`sealed interface`, you can model each screen state explicitly and keep complex transitions readable and testable.
36+
## When Tart Fits Best
37+
38+
Tart works especially well when a feature has multiple explicit UI or business states and the transition rules between them are important.
39+
By combining Kotlin `sealed class`/`sealed interface` with Tart's state machine DSL, you can keep each state's `enter{}`, `action{}`, `exit{}`, and `error{}` behavior close together and make the transition rules easy to follow.
40+
41+
## Current Scope
42+
43+
Tart currently focuses on the core pieces of state management: explicit state transitions, coroutine-based asynchronous work, state persistence, and middleware-driven extensions such as logging and inter-store messaging.
44+
It keeps surrounding helper layers intentionally small, so dependencies and feature composition can stay in ordinary Kotlin, while the core Store logic remains portable across platforms.
3745

3846
## Table of Contents
3947

48+
- [When Tart Fits Best](#when-tart-fits-best)
49+
- [Current Scope](#current-scope)
4050
- [Installation](#installation)
4151
- [Usage](#usage)
4252
- [Basic](#basic)

0 commit comments

Comments
 (0)