aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiguel Ángel Moreno <mail@migalmoreno.com>2023-06-13 21:42:52 +0200
committerMiguel Ángel Moreno <mail@migalmoreno.com>2023-06-14 11:55:20 +0200
commitf685f614cc27d018c4d61589c15dc71fa9f82bb9 (patch)
treeb113fc4d3e2547c8072fd2c4380a4f878a453efc
parent1f5ffe38e9dbf6c0b7c9a531a5f8f1a316253e63 (diff)
doc: Fix typo
-rw-r--r--README2
-rw-r--r--README.md4
2 files changed, 3 insertions, 3 deletions
diff --git a/README b/README
index 6ee0a2f..344a1f2 100644
--- a/README
+++ b/README
@@ -112,7 +112,7 @@ Finally, if you'd like to process non top-level requests only for a given instan
- =redirect-rule= :: a PCRE to match against the current URL or an association list of redirection rules for paths. If the latter, each entry is a cons of the form =REDIRECT . ROUTES=, where =ROUTES= is a list of paths from the =route= that will be redirected to =REDIRECT= in =redirect-url=. To redirect all paths except =ROUTES= to =REDIRECT=, prefix this list with =not=.
-- =original-url= :: takes either a string for the router>'s original host or a =quri:uri= object for the original complete URL. This is useful for storage purposes (bookmarks, history, etc.) so that the original URL is recorded instead of the redirect's URL.
+- =original-url= :: takes either a string for the router's original host or a =quri:uri= object for the original complete URL. This is useful for storage purposes (bookmarks, history, etc.) so that the original URL is recorded instead of the redirect's URL.
=blocker= is a blocking router that takes the following direct slots:
diff --git a/README.md b/README.md
index 1c6727f..b9be182 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
# nx-router
-`nx-router` is a URL routing extension for [Nyxt](https://nyxt.atlas.engineer/). In short, it's an abstraction around Nyxt resource handlers that uses `router` objects to make it more convenient to handle routes. See [Examples](#orgc88d3b8) for a walk-through on how to set up routers.
+`nx-router` is a URL routing extension for [Nyxt](https://nyxt.atlas.engineer/). In short, it's an abstraction around Nyxt resource handlers that uses `router` objects to make it more convenient to handle routes. See [Examples](#org80788cc) for a walk-through on how to set up routers.
The main drive behind `nx-router` was I initially found built-in handlers difficult to reason and I soon became frustrated with the amount of duplicate logic I had to maintain. `nx-router` tries to tackle common needs in resource handling with a redirector, a site blocker, and a resource opener. You can think of it as a more batteries-included `url-dispatching-handler`.
@@ -100,7 +100,7 @@ Finally, if you'd like to process non top-level requests only for a given instan
- **`redirect-rule`:** a PCRE to match against the current URL or an association list of redirection rules for paths. If the latter, each entry is a cons of the form `REDIRECT . ROUTES`, where `ROUTES` is a list of paths from the `route` that will be redirected to `REDIRECT` in `redirect-url`. To redirect all paths except `ROUTES` to `REDIRECT`, prefix this list with `not`.
-- **`original-url`:** takes either a string for the router>'s original host or a `quri:uri` object for the original complete URL. This is useful for storage purposes (bookmarks, history, etc.) so that the original URL is recorded instead of the redirect's URL.
+- **`original-url`:** takes either a string for the router's original host or a `quri:uri` object for the original complete URL. This is useful for storage purposes (bookmarks, history, etc.) so that the original URL is recorded instead of the redirect's URL.
`blocker` is a blocking router that takes the following direct slots: