docs(readme.md): api methods table with description

[fzn0x]

Make ctrl + f over the methods a lot easier on README.

[netlify]

✔️ Deploy Preview for vigilant-wescoff-04e480 ready!

🔨 Explore the source changes: 2aca12c

🔍 Inspect the deploy log: https://app.netlify.com/sites/vigilant-wescoff-04e480/deploys/61e7a2c5e322000007c94cc7

😎 Browse the preview: https://deploy-preview-160--vigilant-wescoff-04e480.netlify.app

[Shinigami92]

There is a rendering issue

---

Beside that, really cool 🙂
Do you want to jump into our Discord ?

[fzn0x]

There is a rendering issue

Beside that, really cool 🙂 Do you want to jump into our Discord ?

Spend 3 hours to test all the faker functions, but it's worth it for me since I always use faker for daily basis.

Yes, i will join the discord, my id fndamental#0001.

[Shinigami92]

Could you also remove the See PR #382 stuff?

Then I will approve it 🙌

[fzn0x]

Could you also remove the See PR #382 stuff?

Then I will approve it 🙌

Sure, i thought it was on current repository, edited.

[damienwebdev]

My opinion is that these should be moved to #82 and then rendered in the https://fakerjs.dev docs. While having in the README is nice, as the API expands we'll see that it becomes cumbersome to maintain. I like the descriptions here, perhaps we can move them into the codebase into the Docblocks if there are any methods missing descriptions?

[Shinigami92]

@damienwebdev I exactly thought the same, but for the short run, this is really nice 👍
We can move it later anyway.

[fzn0x]

I can help with the docblocks, but merge this to another PR will become larger file changes, maybe if I can suggest I can help for the docblocks in different PR or the PR you mentioned.

[damienwebdev]

lgtm