diff options
| author | Miguel Ángel Moreno <mail@migalmoreno.com> | 2023-07-31 11:59:43 +0200 |
|---|---|---|
| committer | Miguel Ángel Moreno <mail@migalmoreno.com> | 2023-07-31 11:59:43 +0200 |
| commit | 3e4181783e36613457ebd5cc5eef4b52a69681ca (patch) | |
| tree | 3146ce557a70286a6bc902b68f4b360a054f0f59 | |
| parent | c1f3d43399474b768dde5e1a8a3c49add4bd00c2 (diff) | |
doc: Update contribution methods
| -rw-r--r-- | README | 6 | ||||
| -rw-r--r-- | README.md | 6 |
2 files changed, 6 insertions, 6 deletions
@@ -1,4 +1,4 @@ -# -*- mode: org; org-html-head-include-default-style: nil; org-html-postamble: nil; -*- +# -*- mode: org; org-html-head-include-default-style: nil; org-html-postamble: nil; after-save-hook: org-md-export-to-markdown; -*- #+OPTIONS: toc:nil num:nil * nx-router =nx-router= is a URL routing extension for [[https://nyxt.atlas.engineer/][Nyxt]]. In short, it's an abstraction around Nyxt resource handlers that uses =router= objects to make it more convenient to handle routes. See [[*Examples][Examples]] for a walk-through on how to set up routers. @@ -11,7 +11,7 @@ The main drive behind =nx-router= was I initially found built-in handlers diffic To install the extension, you need to download the source and place it in Nyxt's extensions path, given by the value of =nyxt-source-registry= (by default =~/.local/share/nyxt/extensions=). #+begin_src sh -git clone https://git.mianmoreno.com/nx-router ~/.local/share/nyxt/extensions/nx-router +git clone https://github.com/migalmoreno/nx-router ~/.local/share/nyxt/extensions/nx-router #+end_src The extension works with *Nyxt 3 onward* but it's encouraged to use it with the latest version of Nyxt master for the time being. @@ -243,4 +243,4 @@ Use a router with a combined =blocklist= path rule for https://github.com. These #+end_src ** Contributing -You can send feedback, patches, or bug reports to [[mailto:public@mianmoreno.com][public@mianmoreno.com]]. +Feel free to open an issue with bug reports or feature requests. PRs are more than welcome too. @@ -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](#org80788cc) 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](#org729b2ad) 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`. @@ -13,7 +13,7 @@ The main drive behind `nx-router` was I initially found built-in handlers diffic To install the extension, you need to download the source and place it in Nyxt's extensions path, given by the value of `nyxt-source-registry` (by default `~/.local/share/nyxt/extensions`). - git clone https://git.mianmoreno.com/nx-router ~/.local/share/nyxt/extensions/nx-router + git clone https://github.com/migalmoreno/nx-router ~/.local/share/nyxt/extensions/nx-router The extension works with **Nyxt 3 onward** but it's encouraged to use it with the latest version of Nyxt master for the time being. @@ -215,5 +215,5 @@ Use a router with a combined `blocklist` path rule for <https://github.com>. The ## Contributing -You can send feedback, patches, or bug reports to [public@mianmoreno.com](mailto:public@mianmoreno.com). +Feel free to open an issue with bug reports or feature requests. PRs are more than welcome too. |