Add Async crock to Documentation

[evilsoft]

Yet Another

This PR adds the Async README to the documentation. That is all.

[coveralls]

Coverage remained the same at 100.0% when pulling 851f625 on move-async-docs into 85d549a on master.

[coveralls]

Coverage remained the same at 100.0% when pulling 851f625 on move-async-docs into 85d549a on master.

[coveralls]

Coverage remained the same at 100.0% when pulling 2d6cff1 on move-async-docs into 85d549a on master.

[karthikiyengar]

I've had a first run at this - I'll do another scan if I find time :-)

[karthikiyengar]

I'm still pretty new to reading signatures, but this doesn't feel right? Did you mean values :: Async String Number -> Async Number String?

[evilsoft]

Nope, that siggy is correct as is. In this case we are map values to their respective types:

// repeat :: String -> Number -> String
// length :: String -> Integer

so the Rejected which runs through length, will take the String and deposit a Number in the Resolved and the repeat('a') will take a Resolved Number and map it to a String before dumping it into a Rejected.

Using the functions to allow mapping keep from the .swap().bimap(repeat('a'), length) which for me at least occurs more often then just a straight .swap(). So the crocks swaps allow for mapping values.

If that makes sense?

[karthikiyengar]

Sure, thanks for the clarification :-)

[karthikiyengar]

This example assumes that the reader is already familiar with what composeK does. Do you think being more explicit would help?

[evilsoft]

I put function like that in these examples as teasers, do people will be like what is this composeK and then go look it up. Like reading a book with a Dictionary, do you think it would be more helpful to the reader to do this instead:

const fake = compose(
  chain(lookup),
  chain(safe(test(/^file-(a|b|c)/)),
  chain(safe(isString))
)

[karthikiyengar]

Sure, we can retain the composeK. The only reason I felt that way because the section header was chain but there was no reference to it in the code snippet.

[evilsoft]

That is an excellent point! Good call! I will make that change for this one, and leave the other one as composeK, which will give a hint as to what the heck composeK could mean. What do you think?

[karthikiyengar]

Sure, I think that makes sense.

[evilsoft]