diff --git a/.github/social-preview.png b/.github/social-preview.png new file mode 100644 index 0000000..1247ce7 Binary files /dev/null and b/.github/social-preview.png differ diff --git a/README.md b/README.md index dfb917b..b428c77 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@

OpenHop

+

+ OpenHop logo +

+

Diagrams your AI agent can write.
Animated, multi-level data flows — described in YAML, drawn by your coding agent. @@ -17,10 +21,10 @@

- CI + CI npm version MIT License - GitHub stars + GitHub stars

@@ -65,7 +69,7 @@ That's it. The CLI starts the API + web UI on `localhost:8787` / `:8788`, posts | **Long-lived local server** | `npx openhop serve` — API + web UI, no starter flow (or `npm install -g openhop` first if you'd rather have the global `openhop` binary) | | **Install the skill** (Claude Code, Cursor, Windsurf, Cline) | `npx openhop init` — auto-detects your AI client and drops `SKILL.md` in place | | **Install the skill** (Codex, Gemini, Junie, Copilot, …) | `npx openskills install naorsabag/openhop` — universal install via OpenSkills | -| **Run from source (contributors)** | `git clone https://github.com/naorsabag/OpenHop.git && cd OpenHop && npm install && npm run dev` — see [Contributing](#contributing) | +| **Run from source (contributors)** | `git clone https://github.com/naorsabag/openhop.git && cd openhop && npm install && npm run dev` — see [Contributing](#contributing) | ## Give your agent the skill @@ -132,7 +136,7 @@ openhop push examples/order-flow.yaml ## Contributing PRs welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). -Security reports via [GitHub's private vulnerability reporting](https://github.com/naorsabag/OpenHop/security/advisories/new). +Security reports via [GitHub's private vulnerability reporting](https://github.com/naorsabag/openhop/security/advisories/new). ## License diff --git a/docs/logo.png b/docs/logo.png new file mode 100644 index 0000000..1247ce7 Binary files /dev/null and b/docs/logo.png differ diff --git a/packages/web/index.html b/packages/web/index.html index 36bd756..51938a2 100644 --- a/packages/web/index.html +++ b/packages/web/index.html @@ -2,7 +2,7 @@ - + diff --git a/packages/web/public/favicon.svg b/packages/web/public/favicon.svg index 6893eb1..a8e2880 100644 --- a/packages/web/public/favicon.svg +++ b/packages/web/public/favicon.svg @@ -1 +1,196 @@ - \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +