From e59b56b5d1d853a7aa9fe1939da5abbff1fbf483 Mon Sep 17 00:00:00 2001 From: Chris Banks Date: Thu, 27 Jul 2023 18:06:23 +0100 Subject: [PATCH] Fix formatting and style in README. - fix broken heading - house style - simplify wording --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index abdbb7a0..9b913844 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,12 @@ --# router +# Router -This is a HTTP reverse proxy router built on top of [`triemux`][tm]. It -loads a routing table into memory from a MongoDB database and acts as a: +GOV.UK Router is an HTTP reverse proxy router built on top of [`triemux`][tm]. +It loads a routing table into memory from a MongoDB database and: -- Reverse proxy, forwarding requests to and serving responses from multiple - backend servers on a single domain. -- Redirector, serving HTTP `301` and `302` redirects to new URLs. -- Gone responder, serving HTTP `410` responses for resources that used to - but no longer exist. +- forwards requests to backend application servers according to the path in the + request URL +- serves HTTP `301` and `302` redirects for moved content and short URLs +- serves `410 Gone` responses for resources that no longer exist The sister project [`router-api`][router-api] provides a read/write interface to the underlying database.