@ferchy/aimc-n8n-toolkit 0.1.0 → 0.1.1

package/README.md

@@ -1,19 +1,30 @@
 # AIMC Toolkit for n8n
 
-AIMC Toolkit is a community node package for n8n with two focused nodes:
+AIMC Toolkit is a community node package for n8n that brings two focused nodes into your workflows:
 
-- **AIMC Code**: Run JavaScript with a curated library toolbox.
-- **AIMC Media**: FFmpeg-based media operations (convert, compress, extract audio, merge, metadata).
+- **AIMC Code**: run JavaScript with a practical toolbox of libraries.
+- **AIMC Media**: FFmpeg-powered media operations without extra glue nodes.
+
+## Why I Built This
+
+I kept hitting the same ceiling in n8n: simple transformations became long chains of Set, IF, and Code nodes, and media tasks required custom scripts or external services. AIMC Toolkit is my answer to that: a reliable, minimal package that removes busywork and keeps workflows fast and readable.
+
+## Who This Is For
+
+- **Automation builders** who want fewer nodes and faster iterations.
+- **Agencies** handling content workflows, clips, and format conversions.
+- **Founders and teams** building internal tooling on n8n.
+- **Power users** who want a better code node and real media ops.
 
 ## Why AIMC Toolkit
 
-- **Faster workflows**: replace multiple utility nodes with one code node.
-- **Media ready**: common FFmpeg tasks in a single, consistent UI.
-- **Practical libraries**: data parsing, validation, formatting, and web utilities built-in.
+- **Fewer nodes, cleaner flows**: consolidate multiple steps into one code node.
+- **Media ready**: convert, compress, merge, and inspect media in one place.
+- **Practical libraries**: parsing, validation, dates, and web utilities built in.
 
 ## Installation
 
-### Community Nodes
+### Community Nodes (Recommended)
 1. Open **Settings > Community Nodes** in n8n.
 2. Install: `@ferchy/aimc-n8n-toolkit`.
 
@@ -30,12 +41,21 @@ AIMC Media will use the first available option:
 2. Optional `ffmpeg-static` / `ffprobe-static`
 3. System FFmpeg on `PATH`
 
-Recommended for servers:
+### Docker (n8n official image)
+```bash
+docker exec <container> apk add --no-cache ffmpeg
+```
+
+### Debian/Ubuntu
 ```bash
-# Debian/Ubuntu
 apt-get update && apt-get install -y ffmpeg
 ```
 
+### macOS (Homebrew)
+```bash
+brew install ffmpeg
+```
+
 ## Nodes
 
 ### AIMC Code
@@ -43,8 +63,9 @@ apt-get update && apt-get install -y ffmpeg
 **Features**
 - Run once for all items or once per item.
 - Access libraries as globals (`axios`, `_`, `zod`) or via `libs`.
+- Built-in helpers (`utils.now`, `utils.safeJson`, `utils.toArray`).
 
-**Example**
+**Example: normalize data**
 ```javascript
 const rows = $input.all().map((i) => i.json);
 const ids = rows.map(() => nanoid());
@@ -57,9 +78,26 @@ return rows.map((row, index) => ({
 }));
 ```
 
-**Library snapshot**
-`axios`, `lodash`, `zod`, `joi`, `yup`, `dayjs`, `date-fns`, `cheerio`, `papaparse`,
-`yaml`, `xml2js`, `qs`, `form-data`, `uuid`, `nanoid`, and more.
+**Example: fetch + parse**
+```javascript
+const response = await axios.get('https://example.com/feed.xml');
+const parsed = await xml2js.parseStringPromise(response.data);
+
+return parsed;
+```
+
+**Library Categories**
+
+- **HTTP + Web**: `axios`, `qs`, `form-data`, `cheerio`, `html-to-text`
+- **Validation**: `zod`, `joi`, `yup`, `validator`, `ajv`
+- **Data + Parsing**: `yaml`, `toml`, `xml2js`, `fast-xml-parser`, `papaparse`
+- **Dates + Time**: `dayjs`, `date-fns`, `date-fns-tz`, `moment-timezone`, `cron-parser`, `ms`
+- **Text + Search**: `fuse.js`, `string-similarity`, `slug`, `pluralize`, `marked`
+- **IDs + Utils**: `uuid`, `nanoid`, `bytes`
+- **Language**: `franc-min`, `compromise`
+- **Media Helpers**: `qrcode`, `ytdl-core`
+
+If you need the full list in the README, tell me and I will add it.
 
 ### AIMC Media
 
@@ -70,16 +108,37 @@ return rows.map((row, index) => ({
 - Merge Video + Audio
 - Metadata (ffprobe)
 
-**Example**
-Convert a video to WebM and scale it:
-```text
+**Key Options**
+- **Input Mode**: Binary or File Path
+- **Output Mode**: Binary or File Path
+- **Output Format**: mp4, webm, mov, mp3, wav, and more
+- **Extra FFmpeg Args**: one per line for advanced control
+
+**Example: convert and scale**
+```
 Operation: Convert / Transcode
 Output Format: WebM
 Additional Output Options:
 -vf scale=1280:-2
 ```
 
-**Large files**
+**Example: compress**
+```
+Operation: Compress
+CRF: 24
+Preset: fast
+Audio Bitrate: 128k
+```
+
+**Example: merge video + audio**
+```
+Operation: Merge Video + Audio
+Input Mode: File Path
+Video File Path: /path/to/video.mp4
+Audio File Path: /path/to/audio.mp3
+```
+
+**Large Files**
 Use **Input Mode = File Path** to avoid loading big files into memory.
 
 ## Configuration
@@ -89,6 +148,16 @@ Environment variables:
 - `FFMPEG_PATH`: custom FFmpeg binary path
 - `FFPROBE_PATH`: custom ffprobe binary path
 
+## Troubleshooting
+
+- **FFmpeg not found**: install FFmpeg or set `FFMPEG_PATH`.
+- **Large files**: use File Path input mode.
+- **Binary output missing**: check `Output Mode` and `Output Binary Property`.
+
+## Support
+
+If you need help or want a feature added, open a GitHub issue once the repo is live.
+
 ## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ferchy/aimc-n8n-toolkit",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "AIMC Toolkit nodes for n8n: code execution and media operations.",
   "license": "MIT",
   "author": "Ferchy",