From aaef29b4b211b5714c67ab9f46db66aecbebed0f Mon Sep 17 00:00:00 2001 From: Bharat Kathi Date: Tue, 27 Aug 2024 16:40:40 -0700 Subject: [PATCH] begin route matching docs --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 7d28b20..9875a47 100644 --- a/README.md +++ b/README.md @@ -321,7 +321,15 @@ San Francisco: /users [GET,POST,DELETE] ### Route Matching +Internally, Rincon computes a route graph to help it match a requested route against its registered routes. This is a simple directed acyclic graph where nodes are route paths and edges are slugs needed to get to the next route path. Nodes also contain information about which services and methods can be handled at that route path. +As an example, let's say we have the following route registrations. + +``` +New York: /users +New York: /users/* +San Francsico: /users/*/notifications +``` ### Example