Skip to content

Commit c5a7c36

Browse files
committed
Add license and table of content for main README
1 parent 69ad729 commit c5a7c36

File tree

3 files changed

+1157
-66
lines changed

3 files changed

+1157
-66
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,26 @@
11
# Backhooks
22

3+
<!-- https://til.simonwillison.net/github-actions/markdown-table-of-contents -->
4+
5+
<!-- toc -->
6+
7+
- [Get started](#get-started)
8+
* [Install dependency](#install-dependency)
9+
* [Write your first hook](#write-your-first-hook)
10+
* [Execute your hook from a context](#execute-your-hook-from-a-context)
11+
- [Usage with HTTP frameworks](#usage-with-http-frameworks)
12+
* [Usage with ExpressJS](#usage-with-expressjs)
13+
* [Usage with Fastify](#usage-with-fastify)
14+
- [Writing hooks](#writing-hooks)
15+
- [Global context](#global-context)
16+
- [Applications](#applications)
17+
* [Logger hook: To log a requestId for each log entry](#logger-hook-to-log-a-requestid-for-each-log-entry)
18+
* [Authentication hooks: To retrieve the authenticated user during a function execution](#authentication-hooks-to-retrieve-the-authenticated-user-during-a-function-execution)
19+
* [Validation hooks: To validate body](#validation-hooks-to-validate-body)
20+
- [Contribute](#contribute)
21+
22+
<!-- tocstop -->
23+
324
Backhooks is a new way to write backend applications by using global hooks scoped to a specific context.
425

526
It can be very useful for an HTTP application, for writing reusable and easily testable code.

0 commit comments

Comments
 (0)