From f2f63e7ab185db11407103e0ef0a15e586f92738 Mon Sep 17 00:00:00 2001 From: marcelo-schreiber Date: Wed, 1 May 2024 18:44:26 -0300 Subject: [PATCH] Update README.md with table of contents --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 874f8c5..616853c 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,23 @@ This is an API for running code in different languages, such as Python, Javascript and Ruby. It uses Docker to run the code in a safe environment, avoiding vulnerabilities and security breaches. +## Table of Contents + +* [Getting Started](#getting-started) + * [Pre requisites](#pre-requisites) + * [Installation](#installation) + * [Run with docker](#run-with-docker) + * [Run in production](#run-in-production) +* [Testing](#testing) +* [API Reference](#api-reference) + * [Returns python code output](#returns-python-code-output) + * [Returns javacript code output](#returns-javacript-code-output) + * [Returns ruby code output](#returns-ruby-code-output) +* [Why Docker? What could go wrong?](#why-docker-what-could-go-wrong) +* [Inspirations and References](#inspirations-and-references) +* [Technologies](#technologies) +* [Feedback](#feedback) + ## Getting Started ### Pre requisites