diff --git a/README.md b/README.md
index 533ecdad3..d19932c14 100755
--- a/README.md
+++ b/README.md
@@ -20,7 +20,21 @@ A RESTful API for Pokémon - [pokeapi.co](https://pokeapi.co)
> Beta GraphQL support is rolling out! Check out the [GraphQL paragraph](#graphql--) for more info.
-## Setup [](https://www.python.org/download/releases/3.10/)
+
+## Table of Contents
+
+- [Setup ](#setup)
+- [Database setup](#database-setup)
+- [Docker and Compose ](#docker-and-compose)
+- [GraphQL ](#graphql)
+- [Kubernetes ](#kubernetes)
+- [Wrappers](#wrappers)
+- [Donations](#donations)
+- [Join Us On Slack!](#join-us-on-slack)
+- [Contributing](#contributing)
+- [Deprecation](#deprecation)
+
+## Setup [](https://www.python.org/download/releases/3.10/)
- Download this source code into a working directory, be sure to use the flag `--recurse-submodules` to clone also our submodules.
@@ -43,7 +57,7 @@ A RESTful API for Pokémon - [pokeapi.co](https://pokeapi.co)
make serve
```
-### Database setup
+## Database setup
To build or rebuild the database by applying any CSV file update, run
@@ -70,7 +84,7 @@ make migrate
Run `make help` to see all tasks.
-## Docker and Compose [](https://hub.docker.com/r/pokeapi/pokeapi)
+## Docker and Compose [](https://hub.docker.com/r/pokeapi/pokeapi)
There is also a multi-container setup, managed by [Docker Compose V2](https://docs.docker.com/compose/). This setup allows you to deploy a production-like environment, with separate containers for each service, and is recommended if you need to simply spin up PokéAPI.
@@ -103,7 +117,7 @@ make docker-make-migrations
make docker-migrate
```
-## GraphQL
+## GraphQL
When you start PokéAPI with the above Docker Compose setup, an [Hasura Engine](https://github.com/hasura/graphql-engine) server is started as well. It's possible to track all the PokeAPI tables and foreign keys by simply
@@ -119,7 +133,7 @@ A free public GraphiQL console is browsable at the address https://beta.pokeapi.
A set of examples is provided in the directory [/graphql/examples](./graphql/examples) of this repository.
-## Kubernetes [](https://github.com/PokeAPI/pokeapi/actions/workflows/docker-k8s.yml)
+## Kubernetes [](https://github.com/PokeAPI/pokeapi/actions/workflows/docker-k8s.yml)
[Kustomize](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/) files are provided in the folder https://github.com/PokeAPI/pokeapi/tree/master/Resources/k8s/kustomize/base/. Create and change your secrets: