diff --git a/README.md b/README.md new file mode 100644 index 0000000..4309666 --- /dev/null +++ b/README.md @@ -0,0 +1,108 @@ +# Vault Autopilot + +Vault Autopilot receives clips from the companion Chrome extension, **[Obsidian Visual Clipper](https://github.com/liyachen/obsidian-visual-clipper)**, and writes them into structured notes and images in your vault — automatically, with no manual paste-and-format step. + +The plugin and the extension are a suite: the extension captures (screenshots, video covers, hooks, keyframes) from your browser; this plugin receives and files them. Neither is useful without the other. + +## What it does + +- **Webpage screenshots** → saved as a standalone note, with images placed in a `frames/` subfolder. +- **Video clips** (cover, hook, keyframe) → all clips from the same video are merged into **one note per video**. Whichever clip type arrives first creates the note; later clips upsert new sections into it. +- Every clip response includes an `obsidian://` deep link back to the note that was created or updated, so the extension can jump you straight to it. + +## Install + +**Community plugin store** (recommended, once listed): open Obsidian → Settings → Community plugins → Browse → search "Vault Autopilot" → Install → Enable. + +**Via BRAT (while the store listing is pending):** install the [BRAT](https://github.com/TfTHacker/obsidian42-brat) plugin, then use "Add a beta plugin" and point it at this repository. + +Vault Autopilot is **desktop-only** — it runs a local Node HTTP server, which is not available on Obsidian mobile. + +You'll also need the [Obsidian Visual Clipper](https://github.com/liyachen/obsidian-visual-clipper) Chrome extension installed for anything to actually reach the plugin. + +## Quickstart + +Vault Autopilot works with **zero configuration**. Install and enable the plugin, install the extension, and start clipping — notes land in the default `Clips/` folders described below. + +To confirm the two sides are talking to each other, open the extension's welcome page: it runs a live self-check against the plugin's health endpoint and lets you send a test clip end-to-end, so you can confirm the whole pipeline before relying on it. + +## Folder layout + +By default, everything lives under `Clips/`: + +``` +Clips/ + Videos/ + covers/ ← video cover images (.webp) + frames/ ← extracted hook / keyframe frames +