Skip to content

Commit

Permalink
Add Table of Contents to README.
Browse files Browse the repository at this point in the history
  • Loading branch information
aljones15 committed Feb 2, 2024
1 parent 447d07c commit 26f26d7
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

[![Bedrock Node.js CI](https://github.com/digitalbazaar/bedrock-server/workflows/Bedrock%20Node.js%20CI/badge.svg)](https://github.com/digitalbazaar/bedrock-server/actions?query=workflow%3A%22Bedrock+Node.js+CI%22)

## Table of Contents

- [Background](#background)
- [Requirements](#requirements)
- [Usage](#usage)
- [Quick Example](#quick-examples)
- [Configuration](#configuration)
- [Setup](#setup)
- [Bedrock Events](#bedrock-events)
- [How It Works](#how-it-works)

## Background
A [bedrock][] module that provides a basic HTTP and HTTPS server. Other
modules, such as [bedrock-express][], typically provide a routing framework
and other features for writing Web applications, but depend on this module
Expand All @@ -12,7 +24,9 @@ redirecting HTTP traffic to the HTTPS port, and configuring SSL/TLS.

- npm v6+

## Quick Examples
## Usage

### Quick Examples

```
npm install @bedrock/server
Expand Down

0 comments on commit 26f26d7

Please sign in to comment.