Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

docs(readme): add hero animation GIF and copy fixes (#2125)

Nick Gomezfbd6f8ff9c5f
diff --git a/README.md b/README.md
index 4fd18224a..2d1f867ab 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,25 @@
OpenKnowledge is a beautiful, local-first markdown editor and LLM wiki with integrations for Claude, Codex, and Cursor.
-The editor has full WYSWIG so that editing markdown feels like editing a Google Doc or Notion page.
+<img
+ src="assets/hero.gif"
+ alt="OpenKnowledge editor with an AI agent drafting a launch recap"
+ width="100%"
+ style="border-radius: 10px"
+/>
-Sharing and auto-sync are available for team-based collaboration are powered by git.
+Available as [macOS app](https://github.com/inkeep/open-knowledge/releases/latest/download/Open-Knowledge-arm64.dmg) or [Web app/CLI](https://openknowledge.ai/docs/reference/cli).
+
+# Features
+
+Key highlights:
+- Full **WYSIWYG** so that editing markdown files feels like editing a Google Doc or Notion page.
+- Collaborative **AI-editing** with Claude, Codex, and Cursor desktop apps.
+- Out-of-the-box **MCP**, **skills**, and templates for LLM Wikis, Agent Second brains, and spec-driven development
+- No-code **Team Sharing** powered by GitHub and git under the hood
+- **Built-in TUI** and CLI for terminal users
+
+Docs for general usage: <https://openknowledge.ai/docs>.
## Install
@@ -19,62 +35,12 @@ ok init # scaffold the project + wire up Claude Code, Cursor, and Codex
ok start --open # serve the editor and open it in your browser
```
-Docs for general usage: <https://openknowledge.ai/docs>.
-
## Contributions
Public pull requests are welcome. When a public PR opens here, automation mirrors it into the internal monorepo for review and merge.
See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
-## Prerequisites
-
-- Bun 1.3.13 or newer (pinned in [`.bun-version`](./.bun-version))
-- Node.js 24 or newer (pinned in [`.node-version`](./.node-version))
-- Git
-
-If you use a Node version manager, pin Node 24 with `fnm install`, `volta install node@24`, or `mise install`. Earlier Node versions fail `engines` checks during `bun install`.
-
-## Quick Start
-
-```bash
-bun install
-bun run check
-```
-
-Run the app locally:
-
-```bash
-bun run --filter @inkeep/open-knowledge-app dev
-```
-
-Run the docs site locally:
-
-```bash
-cd docs
-bun run dev
-```
-
-## Monorepo Layout
-
-- `packages/app` - web app and editor UI
-- `packages/cli` - command-line entrypoint
-- `packages/core` - shared domain logic
-- `packages/desktop` - Electron desktop app
-- `packages/plugin` - agent integration package
-- `packages/server` - local server
-- `docs` - documentation site
-
-## Development
-
-```bash
-bun run format
-bun run lint
-bun run typecheck
-bun run test
-bun run build
-```
-
## License
OpenKnowledge is licensed under the [GNU General Public License v3.0 or later](./LICENSE) (`GPL-3.0-or-later`).
diff --git a/assets/hero.gif b/assets/hero.gif
new file mode 100644
index 000000000..63376a0fd
Binary files /dev/null and b/assets/hero.gif differ