README table of contents (stack-auth#165)

N2D4 · web-flow · commit cdcd64d69e13 · 2024-08-02T16:44:32.000-07:00
diff --git a/.github/workflows/table-of-contents.yaml b/.github/workflows/table-of-contents.yaml
@@ -0,0 +1,12 @@
+on: push
+name: TOC Generator
+jobs:
+  generateTOC:
+    name: TOC Generator
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: technote-space/toc-generator@v4
+        with:
+          TOC_TITLE: ""
diff --git a/README.md b/README.md
@@ -19,7 +19,26 @@ We support Next.js frontends, along with any backend that can use our [REST API]
 <img alt="Stack Setup" src=".github/assets/create-project.gif" height="328" width="400" />
 </div>
 
-## How is this different from `X`?
+## Table of contents
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [How is this different from X?](#how-is-this-different-from-x)
+- [✨ Features](#-features)
+- [📦 Installation & Setup](#-installation--setup)
+- [🌱 Some community projects built with Stack](#-some-community-projects-built-with-stack)
+  - [Templates](#templates)
+  - [Examples](#examples)
+- [🏗️ Development & Contribution](#-development--contribution)
+  - [Requirements](#requirements)
+  - [Setup](#setup)
+  - [Database migrations](#database-migrations)
+- [❤️ Contributors](#-contributors)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## How is this different from X?
 
 Ask yourself about `X`:
 
@@ -53,8 +72,15 @@ Refer to [our documentation](https://docs.stack-auth.com/getting-started/setup)
 
 ## 🌱 Some community projects built with Stack
 
+Have your own? Happy to feature it if you create a PR or message us on [Discord](https://discord.stack-auth.com).
+
+### Templates
 - [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit)
+
+### Examples
 - [Stack Example by career-tokens](https://github.com/career-tokens/StackYCAuth)
+- [Stack Demo by the Stack team](https://github.com/stack-auth/stack/tree/main/examples/demo)
+- [Stack E-Commerce Example by the Stack team](https://github.com/stack-auth/stack/tree/main/examples/e-commerce)
 
 ## 🏗️ Development & Contribution
 
@@ -118,7 +144,7 @@ If you make changes to the Prisma schema, you need to run the following command
 pnpm run prisma migrate dev
 ```
 
-## Contributors
+## ❤️ Contributors
 
 Thanks to the amazing community who built Stack:
 
