Readme fix (index.js)

[mreinigjr]

I made an attempt to better clarify the object accepted by the create method, the arguments accepted by the returned function (def) from the create method, added type signatures for both create and def and commented an example where def is used. All changes are simple and my fp knowledge is limited, but growing :smile:. So please let me what is wrong or feel free to correct anything that is not documented correctly. Lastly, I could not figure out how you auto generated the docs from the index.js file, so the end result may not be quite right, but all tests are passing.

[davidchambers]

Thanks for submitting this pull request, @mreinigjr! I will leave comments in situ.

[mreinigjr]

@davidchambers, I just wanted to check in. I believe all changes you wanted have been submitted. Please let me know if there is anything further I can do on this PR. Thanks!

[davidchambers]

Thanks again for this contribution, @mreinigjr. I combined your commits into a single commit, removed the portions of the commit message that are no longer applicable, and rearranged one sentence. I enjoyed writing the following script to demonstrate how the final commit message is derived from two earlier commit messages:

#!/usr/bin/env bash

function new {
  git --no-pager show ccf3c12663557a9b1dd57c6950077ae1f376607e --no-patch --format=format:'Author: %an <%ae>%n'
  git --no-pager show ccf3c12663557a9b1dd57c6950077ae1f376607e --no-patch --format=format:'Date:   %ad%n%n'
  git --no-pager show ccf3c12663557a9b1dd57c6950077ae1f376607e --no-patch --format=format:'%s%n%n'
  git --no-pager show ccf3c12663557a9b1dd57c6950077ae1f376607e --no-patch --format=format:'%b' | paste -s -d ' ' -
}

function old {
  git --no-pager show 731804397dd69289a1c243a4a850ba9e0dbb99b3 --no-patch --format=format:'Author: %an <%ae>%n'
  git --no-pager show 731804397dd69289a1c243a4a850ba9e0dbb99b3 --no-patch --format=format:'Date:   %ad%n%n'
  git --no-pager show 5822d6d6c93f5e4eb5cd74245878a9a462cb1533 --no-patch --format=format:'%s%n%n'
  git --no-pager show 731804397dd69289a1c243a4a850ba9e0dbb99b3 --no-patch --format=format:'%b' | paste -s -d ' ' - \
  | sed -E \
"s!"\
"(Type signature)s( for the 'def' function )and the 'create' method are"\
"( not well documented here. Type signatures)( for) both( 'def') and 'create'"\
"( when introduced)( have been added)( as well as comments in example)s"\
"(. Hopefully, this adds clarity.).*"\
"!\1\2is\3\7\4\5\6\8\9!"
}

new | shasum -a 256
old | shasum -a 256

[mreinigjr]

It was my pleasure @davidchambers and thank you for all the feedback.