From 2aeb1bc6d63db4f61d9cc359c39dac67c95a5dca Mon Sep 17 00:00:00 2001 From: Hagop Jamkojian Date: Sat, 22 Aug 2020 00:20:39 +0200 Subject: [PATCH] Update README.md --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 39cb289d..97555f7a 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,20 @@ A boilerplate/starter project for quickly building production-ready RESTful APIs It comes with many built-in features, such as authentication using JWT, request validation, unit and integration tests, continuous integration, docker support, API documentation, pagination, etc. For more details about the features, check the list below. +## Table of Contents + +- [Features](#features) +- [Getting Started](#getting-started) +- [Project Structure](#project-structure) +- [API Documentation](#api-documentation) +- [Error Handling](#error-handling) +- [Validation](#validation) +- [Authentication](#authentication) +- [Authorization](#authorization) +- [Logging](#logging) +- [Custom Mongoose Plugins](#custom-mongoose-plugins) +- [Linting](#linting) + ## Features - **ES9**: latest ECMAScript features @@ -289,7 +303,7 @@ Note: API request information (request url, response code, timestamp, etc.) are ## Custom Mongoose Plugins -The app also contains 2 custom mongoose plugins that you can attach to any mongoose model schema. You can find the plugins in `src/models/plugins.js`. +The app also contains 2 custom mongoose plugins that you can attach to any mongoose model schema. You can find the plugins in `src/models/plugins`. ```javascript const mongoose = require('mongoose');