aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2022-03-04 15:31:00 +0500
committerEgor Tensin <Egor.Tensin@gmail.com>2022-03-04 15:32:12 +0500
commita9bb94fe6f089ff8615178a16396b7f654ebf437 (patch)
tree1dc49bd98635ecf3611912f4b873df66db76b7e3
parentMakefile: move `npm install` to separate target (diff)
downloadwireguard-config-a9bb94fe6f089ff8615178a16396b7f654ebf437.tar.gz
wireguard-config-a9bb94fe6f089ff8615178a16396b7f654ebf437.zip
README: update
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 36c1676..2904a33 100644
--- a/README.md
+++ b/README.md
@@ -73,6 +73,23 @@ be browsed without running a web server.
One workaround is to `wget` the website (use `make wget`).
The truly static version will be downloaded to the .wget/ directory.
+### Node.js dependencies
+
+For IP address parsing and validation, [ipaddr.js] was used originally.
+It is pre-built for browser use, which is nice; however, it's [buggy].
+
+It was replaced by [ip-address], which is not browser-ready; instead,
+[Browserify] is used to turn it into a suitable .js file
+(`make npm && make bundle`).
+
+This whole situation sucks, but I really want to keep this website static.
+TODO: find other options or wait until ipaddr.js fixes the bug.
+
+[ipaddr.js]: https://github.com/whitequark/ipaddr.js
+[buggy]: https://github.com/whitequark/ipaddr.js/issues/160
+[ip-address]: https://github.com/beaugunderson/ip-address
+[Browserify]: https://browserify.org/
+
License
-------