README.md expand import examples

[mb21]

Proposal to expanded the README to what I was looking for to get started. Feel free to change.

I was also not sure what this sentence means:

Because the Iterator.prototype methods depend on a receiver (the this value), the main export in each subdirectory takes the string to operate on as the first argument.

Does it relate to explicit imports instead of shimming or is it an implementation detail?

[ljharb]

It means that instead of forcing you to do, eg, require('es-iterator-helpers'/Iterator.prototype.drop').call(iterator, count), you'd do require('es-iterator-helpers'/Iterator.prototype.drop')(iterator, count). "The string" there is a mistake; it should be "the iterator".

[ljharb]

This is fine, but if you're using node you need to be able to look at either CJS or ESM examples and implicitly understand how to convert one to the other.

[mb21]

Right, I mean I figured it out eventually what the require path was relative to, how to convert CJS to ESM and which module executed the shims automagically. But all three together were a bit many hurdles for my taste, hence this PR.

I pushed two commits (to make CI pass and to fix the typo you mentioned), so now it's ready to merge I think.

[ljharb]

Removing evalmd is like deleting tests - the benefit of having an ESM example is much much smaller than the benefit of guaranteeing readme examples are correct.

That said, i think evalmd has an html comment way to ignore specific code blocks, so that might work here.

[mb21]

Done...

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.00%. Comparing base (698cef7) to head (231f4db).
Report is 6 commits behind head on main.

❗ Current head 231f4db differs from pull request most recent head ae0b60c. Consider uploading reports for the commit ae0b60c to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main       #6      +/-   ##
==========================================
- Coverage   89.71%   89.00%   -0.71%     
==========================================
  Files          86       86              
  Lines        1011     1019       +8     
  Branches      135      127       -8     
==========================================
  Hits          907      907              
- Misses        104      112       +8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.