From 9bc9e59f41f27ddaeb18cbe08a41b78c5e900f46 Mon Sep 17 00:00:00 2001 From: Yuchen Pei Date: Mon, 30 Oct 2023 21:41:14 +1100 Subject: Documentation and license. --- README.org | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 README.org (limited to 'README.org') diff --git a/README.org b/README.org new file mode 100644 index 0000000..4d61cd9 --- /dev/null +++ b/README.org @@ -0,0 +1,46 @@ +#+title: url-rewrite +#+author: Yuchen Pei +#+language: en + +* Introduction + :PROPERTIES: + :UPDATED: [2023-10-30 Mon 21:40] + :END: + +~url-rewrite~ is an elisp library for rewriting URLs. Usecases include +redirecting to an random alternative client, removing tracking +queries, converting a zoom link to a dial-in number etc. + +* Usage + :PROPERTIES: + :UPDATED: [2023-10-30 Mon 21:41] + :END: + +One way to use it would be utilising the collection of building block +functions for URL rewriting, like ~url-rw-replace-random-host~ and +~url-rw-remove-query~. + +Another, more streamlined usage would be: + +1. Declare rewriting rules in ~url-rw-rules~ (see + ~url-rw-example-rules~ for example) + +2. Then declare some ad-hoc rewriting functions and add them to + ~url-rw-extra-rewriters~. An example is + ~url-rw-example-zoom-to-dial~. + +3. Eval ~(url-rw-refresh)~ to populate the rewrite function list + ~url-rw-rewriters~. + +4. The function ~url-rw~ can now be used on any url you wish to + rewrite. + +* Copyright and contact + :PROPERTIES: + :UPDATED: [2023-10-30 Mon 21:39] + :END: + +~url-rewrite~ is maintained by Yuchen Pei and covered by +[[https://www.gnu.org/licenses/agpl-3.0.en.html][GNU AGPLv3+]]. You may find the license text in a file named +COPYING.agpl3 in the project tree. For comments, bug reports or +patches, please use the mailing list [[https://lists.sr.ht/~ycp/gym][~ycp/gym@lists.sr.ht]]. -- cgit v1.2.3