updated README with Table Of Contents

[27Jashshah]

Added a Table of Contents, with clickable links to the sections, to the README file.

[phalt]

This is a cool suggestion. Did you generate this with an auto-generator or do it yourself? Usually an autogenerated list wouldn't create the <a> tags because Github's markdown parser turns headings into links automatically.

[Naramsim]

Doctoc is one of the generators I used in the past.

I don't know if we need a toc

Definitely the 'a' tags aren't needed

[27Jashshah]

So basically I was trying to add a toc with clickable links however it was not working for the top 5 sections for some reason, which is why I added the 'a' tags.

[phalt]

@27Jashshah what you can do is go to this readme on github.com, click each heading to see the correct link, like this one:

https://github.com/PokeAPI/pokeapi?tab=readme-ov-file#database-setup

the anchor you want is the part after the #

[raghav2005]

I definitely think that having a ToC makes the README a lot easier to navigate (and to see what's ahead in the README without having to explicitly scroll down), but yeah, there's no need to include the tags cuz I'm pretty sure GitHub automatically handles jumping in Markdowns. I'd be down to fix this myself but not sure how or even if I can edit a PR without being a maintainer.

[27Jashshah]

Ok, so the thing is, with the no-breaking spaces ( ), GitHub and Markdown files don't read the headers as they normally would (at least, to my knowledge), so the tags are required for these ones. I have updated the code so that only the headers with the no-breaking space have the tags - I'm just about to commit this change.

[phalt]

Nice work and thank you for the contribution!

[pokeapi-machine-user]

A PokeAPI/api-data refresh has started. In ~45 minutes the staging branch of PokeAPI/api-data will be pushed with the new generated data.

The staging branch will be deployed in our staging environment and the entire API will be ready to review.

A Pull Request (master<-staging) will be also created at PokeAPI/api-data and assigned to the PokeAPI Core team to be reviewed. If approved and merged new data will soon be available worldwide at pokeapi.co.

[pokeapi-machine-user]

The updater script has finished its job and has now opened a Pull Request towards PokeAPI/api-data with the updated data.

The Pull Request can be seen deployed in our staging environment when CircleCI deploy will be finished (check the start time of the last build).