From daa62c30812a258c18524ba5d3821958973a338a Mon Sep 17 00:00:00 2001
From: Raymond Hill <rhill@raymondhill.net>
Date: Mon, 7 Oct 2024 08:56:34 -0400
Subject: [PATCH] Update README for npm package

---
 platform/{nodejs => npm}/README.md | 2 ++
 tools/make-nodejs.sh               | 1 -
 tools/make-npm.sh                  | 1 +
 3 files changed, 3 insertions(+), 1 deletion(-)
 rename platform/{nodejs => npm}/README.md (98%)

diff --git a/platform/nodejs/README.md b/platform/npm/README.md
similarity index 98%
rename from platform/nodejs/README.md
rename to platform/npm/README.md
index db6c5d775..a1ce7f42e 100644
--- a/platform/nodejs/README.md
+++ b/platform/npm/README.md
@@ -27,6 +27,8 @@ and also lists of domain names or hosts file format (i.e. block lists from [The
 
 ## Usage
 
+See `./demo.js` in package for instructions to quickly get started.
+
 At the moment, there can be only one instance of the static network filtering
 engine ("SNFE"), which proxy API must be imported as follow:
 
diff --git a/tools/make-nodejs.sh b/tools/make-nodejs.sh
index b17a0a469..270456814 100755
--- a/tools/make-nodejs.sh
+++ b/tools/make-nodejs.sh
@@ -41,5 +41,4 @@ node -pe "JSON.stringify(Array.from(fs.readFileSync('src/lib/publicsuffixlist/wa
     > $DES/lib/publicsuffixlist/wasm/publicsuffixlist.wasm.json
 
 cp platform/nodejs/*.js      $DES/
-cp platform/nodejs/README.md $DES/
 cp LICENSE.txt               $DES/
diff --git a/tools/make-npm.sh b/tools/make-npm.sh
index 6bffadc73..8a17b0e3c 100755
--- a/tools/make-npm.sh
+++ b/tools/make-npm.sh
@@ -20,6 +20,7 @@ cp    platform/npm/*.json      $DES/
 cp    platform/npm/.*.json     $DES/
 cp    platform/npm/*.js        $DES/
 cp -R platform/npm/tests       $DES/
+cp    platform/npm/README.md   $DES/
 
 cd $DES
 cd tests/data