📚 Socket documentation.

Author: connor-ricks

README.md

@@ -123,6 +123,16 @@ Group(path: "movies", ":movie") {
 }
 ``` 
 
+### Websockets
+
+Defining a websocket is as simple as using the `Socket` route component.
+
+```swift
+Group(path: "api") {
+    Socket("foo") { ... }
+}
+```
+
 ### Expressions & Logic
 
 `@ResultBuilder` supports a wide variety of the available result builder syntax.

Sources/VaporRouteBuilder/RouteComponents/Socket.swift

@@ -25,6 +25,16 @@ import Vapor
 
 // MARK: - Socket
 
+/// A route component that defines a websocket at a given path.
+///
+/// Use `Socket` in a route builder to define a websocket connection at the specified path.
+///
+/// ```swift
+/// Group(path: "api") {
+///     Socket("foo") { ... }
+/// }
+/// ```
+/// 
 public struct Socket: RouteComponent {
 
     // MARK: Properties
@@ -62,3 +72,9 @@ public struct Socket: RouteComponent {
         route
     }
 }
+
+// MARK: - RouteComponents + Socket
+
+extension RouteComponents {
+    public typealias Socket = VaporRouteBuilder.Socket
+}