chore: remove helpers.userCard() from README.md

[andrecastelo]

Related to #528 and #543. Since the helpers.*Card methods were deprecated we need to remove the example from README.md.

[Shinigami92]

I also had this in mind, but we may want to replace it with e.g. the arrayElement function, so at least there is one example.

Alternatively we could remove the whole section and just refer to the docs 🤔

[andrecastelo]

I also had this in mind, but we may want to replace it with e.g. the arrayElement function, so at least there is one example.

Alternatively we could remove the whole section and just refer to the docs 🤔

True, true. IMO it is better if we leave the example there - it helps with discoverability, and then the user can look into the docs for more helper methods. Also the docs link is not very prominent (I think would be nice if the link was moved to the header, next to the stackblitz link).

[codecov]

Codecov Report

Merging #1013 (422cac2) into main (d463ff8) will decrease coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1013      +/-   ##
==========================================
- Coverage   99.67%   99.67%   -0.01%     
==========================================
  Files        2115     2115              
  Lines      227025   227025              
  Branches      983      982       -1     
==========================================
- Hits       226280   226277       -3     
- Misses        725      728       +3     
  Partials       20       20              

Impacted Files	Coverage Δ
src/modules/finance/index.ts	99.31% <0.00%> (-0.69%)	⬇️

[andrecastelo]

Added faker.helpers.arrayElement() example, and added a link to the Documentation at the top of README.md