docs: add TOC to root README (typescript-eslint#838)

jamesgeorge007 · bradzacher · commit 5f92b9f0b21e · 2019-10-11T09:01:33.000-07:00
diff --git a/README.md b/README.md
@@ -13,6 +13,24 @@
 
 <br>
 
+## Table of Contents
+
+- [Getting Started](#getting-started)
+- [What are ESLint and TypeScript, and how do they compare?](#what-are-eslint-and-typescript-and-how-do-they-compare)
+- [Why does this project exist?](#why-does-this-project-exist)
+- [What about TSLint?](#what-about-tslint)
+- [How does typescript-eslint work and why do you have multiple packages?](#how-does-typescript-eslint-work-and-why-do-you-have-multiple-packages)
+- [Can I use all of the existing ESLint plugins and rules without any changes?](#can-i-use-all-of-the-existing-eslint-plugins-and-rules-without-any-changes)
+- [Can we write rules which leverage type information?](#can-we-write-rules-which-leverage-type-information)
+- [What about Babel and babel-eslint?](#what-about-babel-and-babel-eslint)
+- [How can I help?](#how-can-i-help)
+- [How do I configure my project to use typescript-eslint?](#how-do-i-configure-my-project-to-use-typescript-eslint)
+- [Package Versions](#package-versions)
+- [Supported TypeScript Version](#supported-typescript-version)
+- [License](#license)
+- [Contributors](#contributors)
+- [Contributing Guide](#contributing-guide)
+
 ## Getting Started
 
 The following sections will give you an overview of what this project is, why it exists and how it works at a high level.
