diff options
author | Miguel Ángel Moreno <mail@migalmoreno.com> | 2023-01-23 13:05:55 +0100 |
---|---|---|
committer | Miguel Ángel Moreno <mail@migalmoreno.com> | 2023-01-23 13:05:55 +0100 |
commit | a9a2f99d696faab1d573c5206278341d722d44b2 (patch) | |
tree | ef2d21ea6ecdc2ede2d2b18ff3b6dbaace91b62a | |
parent | ae8ce6d45cc3b84ce7733262ac13a0adfd4f5aa8 (diff) |
chore: Shorten project description
-rw-r--r-- | README | 6 |
1 files changed, 3 insertions, 3 deletions
@@ -1,11 +1,11 @@ # -*- mode: org; org-html-head-include-default-style: nil; org-html-postamble: nil; -*- #+OPTIONS: toc:nil * nx-router -=nx-router= is a URL routing extension for [[https://nyxt.atlas.engineer/][Nyxt]]. In short, it's an abstraction around the idea of Nyxt request resource handlers, and introduces the concept of =route= objects a user can consume with a set of predefined slots. It's built to be composable by allowing you to combine many routes together and extensible by making it really easy to define new routes. +=nx-router= is a URL routing extension for [[https://nyxt.atlas.engineer/][Nyxt]]. In short, it's an abstraction around Nyxt request resource handlers that introduces the concept of =route= objects. -Over time, I found the built-in functionality in Nyxt for resource handling becomes difficult to maintain and reason about. I started by using plain handlers to achieve some of the functionality I needed, but became frustrated with the amount of duplicate logic I found myself writing and the fact I had to come up with everything by myself when I wanted more complex logic. +Over time, I found the built-in functionality in Nyxt for resource handling becomes difficult to maintain and reason about. I started by using plain handlers to achieve what I needed, but became frustrated with the amount of duplicate logic I found myself writing and the fact I had to come up with everything by myself when I wanted more complex logic. -=nx-router= is built with the aim of finding a common ground to the most common needs in resource handling. It also aims at making it easy for users to create new routes others can use, so that Nyxt users are no longer tied to their own hacky workarounds. It currently provides five routes: a general-purpose redirector, a general-purpose site blocker, a resource opener, a media toggler, and a =web-route= that ties all of these together for more complex requirements. +=nx-router= is built with the aim of finding a common ground to the most common needs in resource handling. It currently provides five routes: a general-purpose redirector, a general-purpose site blocker, a resource opener, a media toggler, and a =web-route= that ties all of these together for more complex requirements. If you're coming from standard browsers, you can think of =nx-router= as similar to existing solutions like [[https://github.com/einaregilsson/Redirector][Redirector]] and [[https://github.com/proginosko/LeechBlockNG][LeechblockNG]] put together and on steroids. If you're privacy-minded and already use Nyxt, you might have stumbled upon [[https://github.com/kssytsrk/nx-freestance-handler][nx-freestance-handler]], an extension akin to [[https://github.com/libredirect/libredirect][LibRedirect]] which redirects popular sites to their privacy-friendly front-ends. The problem I see with such extensions is they limit the user to a few predefined sites and create an implicit dependency on their maintainer to update the extension each time one of these goes down or changes its URL structure. See [[*Examples][Examples]] for a walk-through on how to set routes up, including how to replicate all of the =nx-freestance-handler= functionality. |