repos / starfx

commit

8015488

parent

059dd3b

author

Eric Bower

date

2023-12-04 01:40:02 +0000 UTC

docs: readme

 1@@ -27,8 +27,7 @@ Read my introductory blog post:
 2 - leverage structured concurrency to manage side-effects
 3 - side-effect and state management decoupled from the view layer
 4 - full control over state management
 5-- state is just a side-effect of user interaction and app features
 6-- state management should not be coupled to the view
 7+- state is just a side-effect (of user interaction and app features)
 8 
 9 # example: thunks are tasks for business logic
10 
11@@ -173,6 +172,21 @@ function App() {
12 
13 Please see [examples repo](https://github.com/neurosnap/starfx-examples).
14 
15+# when to use this library?
16+
17+This primary target for this library are single-page apps (SPAs). This is for an
18+app that might live as a simple web server that serves FE assets and all content
19+is generated on the user's machine.
20+
21+Is your app highly interactive, requiring it to persist data across pages? This
22+is the sweet spot for `starfx`.
23+
24+You can use this library as general purpose structured concurrency, but
25+[effection](https://github.com/thefrontside/effection) serves those needs well.
26+
27+You could use this library for SSR, but I don't heavily build SSR apps, so I
28+cannot claim it'll work well.
29+
30 # what is structured concurrency?
31 
32 This is a board term so I'll make this specific to how `starfx` works.