README

nuclia · May 7, 2024 · 9286e20 · 9286e20
1 parent 863ddae
commit 9286e20
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/extractor/CHANGELOG.md b/extractor/CHANGELOG.md
@@ -0,0 +1,3 @@
+# 1.0.0 (2024-05-07)
+
+- Initial release
diff --git a/extractor/README.md b/extractor/README.md
@@ -1 +1,18 @@
 # Web page extractor
+
+Allows to extrcat the HTML content of a web page.
+
+It must be used in conjunction with the [Nuclia Sync agent](https://github.com/nuclia/sync-agent).
+It must be deployed on the same machine as the Nuclia Sync agent, and it runs on port 8091.
+
+## Installation
+
+```bash
+npm install @nuclia/extractor
+```
+
+## Usage
+
+```bash
+npm start
+```