improve imitate readMe docs()

[ShayMatasaro]

the imitate() docs in readMe , say :
"The following is an example where imitate() is important in Cycle.js applications. A parent component contains some child components. A child has an action stream which is given to the parent to define its state:"

which means that whenever a parent state depends on child actions , imitate should be used

but the circular dependency only happens when on top of the above the child actions are dependent on parent actions ?

[xtianjohns]

I believe this specific wording might be the point of confusion:

to define its state

So, if you think of the subject of this sentence, @ShayMatasaro, as the child, I think your question is answered and the documentation explains the use case. Specifically, the child returns an action stream, and that stream is used in part to define the streams provided as a part of the child's sources.

Do think think that a revisit of just that language would be enough to appropriately demonstrate when to imitate streams? Or do you think another example, perhaps one that demonstrates its usage in the context of CycleJS components, is required?

[ShayMatasaro]

@xtianjohns yes the "its" can be confusing in this context , how about :
"A child has an action stream which is given to the parent, and the parent provides it back to the child as a source"
or something similar

Yes, A real world example where a dev can "unknowingly" end up with such a paradigm would be great, although I cant think of one currently.