pompelmi 1.2.2 → 1.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/.claude/settings.local.json +3 -1
  2. package/README.md +18 -2
  3. package/package.json +10 -9
package/.claude/settings.local.json CHANGED
@@ -43,7 +43,9 @@
43
43
  "Bash(npm install:*)",
44
44
  "Bash(npm ls:*)",
45
45
  "Bash(wait)",
46
- "Bash(git rebase *)"
46
+ "Bash(git rebase *)",
47
+ "Bash(python3 *)",
48
+ "Bash(git *)"
47
49
  ]
48
50
  }
49
51
  }
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
  <img src="./src/grapefruit.png" width="88" alt="pompelmi logo">
3
3
  </p>
4
4
 
5
- <h1 align="center">pompelmi</h1>
5
+ # pompelmi — ClamAV Antivirus Scanning for Node.js
6
6
 
7
7
  <p align="center"><strong>ClamAV antivirus scanning for Node.js — clean, typed, zero dependencies.</strong></p>
8
8
 
@@ -15,11 +15,13 @@
15
15
  <img src="https://img.shields.io/badge/dependencies-0-brightgreen" alt="zero dependencies">
16
16
  </p>
17
17
 
18
+ ![Node.js CI](https://github.com/pompelmi/pompelmi/actions/workflows/ci.yml/badge.svg)
19
+
18
20
  ---
19
21
 
20
22
  ## Overview
21
23
 
22
- pompelmi is a minimal Node.js wrapper around [ClamAV](https://www.clamav.net/) that exposes a single async function — `scan()` — and returns one of three typed verdict Symbols: `Verdict.Clean`, `Verdict.Malicious`, or `Verdict.ScanError`.
24
+ pompelmi is a minimal Node.js wrapper around [ClamAV](https://www.clamav.net/) that exposes a single async function — `scan()` — and returns one of three typed verdict Symbols: `Verdict.Clean`, `Verdict.Malicious`, or `Verdict.ScanError`. Full documentation at [pompelmi.app](https://pompelmi.app).
23
25
 
24
26
  It supports two scanning modes:
25
27
 
@@ -30,6 +32,14 @@ No cloud. No daemon required for local mode. No native bindings. Zero runtime de
30
32
 
31
33
  ---
32
34
 
35
+ ## Why pompelmi
36
+
37
+ If you need to **scan file uploads for viruses in Node.js**, integrate **ClamAV with Express or Fastify**, or add **antivirus scanning to any upload pipeline**, pompelmi is the simplest path.
38
+
39
+ Most integrations require parsing ClamAV's stdout with regex, managing a clamd daemon, or working around unmaintained packages. pompelmi does none of that: one function call, exit-code-mapped verdicts, zero dependencies.
40
+
41
+ ---
42
+
33
43
  ## Features
34
44
 
35
45
  - Single `scan(filePath, [options])` function — works locally or against a remote clamd instance
@@ -54,6 +64,8 @@ pompelmi does not bundle or automatically download ClamAV. Install it once per m
54
64
 
55
65
  ## Installation
56
66
 
67
+ See [pompelmi.app](https://pompelmi.app) for the full getting-started guide.
68
+
57
69
  ```bash
58
70
  # npm
59
71
  npm install pompelmi
@@ -384,3 +396,7 @@ Please read [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) before contributing. To r
384
396
  ## License
385
397
 
386
398
  [ISC](./LICENSE) — © pompelmi contributors
399
+
400
+ ---
401
+
402
+ [pompelmi.app](https://pompelmi.app) · [npm](https://www.npmjs.com/package/pompelmi) · [GitHub](https://github.com/pompelmi/pompelmi)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pompelmi",
3
- "version": "1.2.2",
3
+ "version": "1.2.4",
4
4
  "description": "ClamAV for humans — scan any file and get back Clean, Malicious, or ScanError. No daemons. No cloud. No native bindings.",
5
5
  "license": "ISC",
6
6
  "author": "pompelmi contributors",
@@ -15,18 +15,19 @@
15
15
  "keywords": [
16
16
  "clamav",
17
17
  "antivirus",
18
- "malware",
19
18
  "virus-scan",
20
- "file-scan",
19
+ "malware",
20
+ "file-upload",
21
21
  "security",
22
+ "scan",
22
23
  "clamscan",
23
- "malware-detection",
24
- "virus-detection",
25
- "file-upload-security",
26
- "upload-scan",
27
- "nodejs-security",
28
24
  "clamd",
29
- "eicar",
25
+ "instream",
26
+ "nodejs",
27
+ "express",
28
+ "fastify",
29
+ "nestjs",
30
+ "multer",
30
31
  "zero-dependencies"
31
32
  ],
32
33
  "type": "commonjs",