eproxus · November 19, 2024 21:31 · Nov 4, 2023 · Jun 6, 2021 · Jun 2, 2021 · Jun 2, 2021
diff --git a/COWBOY_MIDDLEWARE.md b/COWBOY_MIDDLEWARE.md
@@ -1,9 +1,5 @@
 # How to Create a Cowboy Middleware
 
-| :warning:  |
-|:-----------|
-|Middlewares are "deprecated" because stream handlers can do everything middlewares can do and more. Consider using a stream handler instead.  |
-
 Add an entry to the `middlewares`. Usually you want to keep the standard Cowboy
 handlers afterwards, but you can replace them if you want.
 

diff --git a/README.md → COWBOY_MIDDLEWARE.md b/README.md → COWBOY_MIDDLEWARE.md
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# How To Create a Cowboy Middleware
+# How to Create a Cowboy Middleware
 
 | :warning:  |
 |:-----------|

diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+# How To Create a Cowboy Middleware
+
 | :warning:  |
 |:-----------|
 |Middlewares are "deprecated" because stream handlers can do everything middlewares can do and more. Consider using a stream handler instead.  |
@@ -17,7 +19,7 @@ handlers afterwards, but you can replace them if you want.
 
 A middleware implements the behavior `cowboy_middleware`.
 
-# Caveats
+## Caveats
 
 * You cannot change a response after it has been sent. For example, if you add a
   middleware after the generic `cowboy_handler` middleware. If a previous

diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 | :warning:  |
-|:---------:|
+|:-----------|
 |Middlewares are "deprecated" because stream handlers can do everything middlewares can do and more. Consider using a stream handler instead.  |
 
 Add an entry to the `middlewares`. Usually you want to keep the standard Cowboy

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-| :warning: |
+| :warning:  |
 |:---------:|
-| Middlewares are "deprecated" because stream handlers can do everything middlewares can do and more. Consider using a stream handler instead. |
+|Middlewares are "deprecated" because stream handlers can do everything middlewares can do and more. Consider using a stream handler instead.  |
 
 Add an entry to the `middlewares`. Usually you want to keep the standard Cowboy
 handlers afterwards, but you can replace them if you want.

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 | :warning: |
 |:---------:|
-|foo        |
+| Middlewares are "deprecated" because stream handlers can do everything middlewares can do and more. Consider using a stream handler instead. |
 
 Add an entry to the `middlewares`. Usually you want to keep the standard Cowboy
 handlers afterwards, but you can replace them if you want.

diff --git a/README.md b/README.md
@@ -0,0 +1,26 @@
+| :warning: |
+|:---------:|
+|foo        |
+
+Add an entry to the `middlewares`. Usually you want to keep the standard Cowboy
+handlers afterwards, but you can replace them if you want.
+
+```erlang
+{ok, Pid} = cowboy:start_clear(ListenerName,
+    [{port, Port}],
+    #{
+        env => #{dispatch => Dispatch},
+        middlewares => [my_middleware, cowboy_router, cowboy_handler]
+    }
+),
+```
+
+A middleware implements the behavior `cowboy_middleware`.
+
+# Caveats
+
+* You cannot change a response after it has been sent. For example, if you add a
+  middleware after the generic `cowboy_handler` middleware. If a previous
+  middleware has called the `cowboy_req:reply/4` function the response has
+  already been sent on the wire. For that purpose you need to use a stream
+  handler instead.
diff --git a/my_middleware.erl b/my_middleware.erl
@@ -0,0 +1,9 @@
+-module(my_middleware).
+
+-behaviour(cowboy_middleware).
+
+-export([execute/2]).
+
+execute(Req, Env) ->
+    io:format("~p request~n", [cowboy_req:method(Req)]),
+    {ok, Req2, Env}.