Skip to content

Commit

Permalink
Fix formatting and style in README.
Browse files Browse the repository at this point in the history
- fix broken heading
- house style
- simplify wording
  • Loading branch information
sengi committed Jul 27, 2023
1 parent 98130a3 commit e59b56b
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit e59b56b

Please sign in to comment.