Skip to content

Commit d2bebfa

Browse files
committed
update readme
1 parent ddbd10e commit d2bebfa

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ OpenKB has two layers: a **wiki foundation** that compiles and maintains your kn
2626

2727
### Features
2828

29-
- **Broad format support:** PDF, Word, Markdown, PowerPoint, HTML, Excel, CSV, text, URLs, and more
30-
- **Scale to long documents:** Long and complex documents are handled via [PageIndex](https://github.com/VectifyAI/PageIndex) tree indexing, enabling accurate, vectorless context-aware retrieval
31-
- **Native multi-modality:** Retrieves and understands figures, tables, and images, not just text
32-
- **Compiled Wiki:** LLM compiles your documents into summaries, concept pages, entity pages, and cross-links, all kept in sync
33-
- **Query & Chat:** One-off questions or multi-turn conversations over your wiki, with persisted sessions you can resume
34-
- **Skill Factory:** Distill redistributable agent skills from your wiki
35-
- **Obsidian compatible:** Wiki is plain `.md` files with `[[wikilinks]]`. Open in Obsidian for graph view and browsing
29+
- **Broad format support:** PDF, Word, Markdown, PowerPoint, HTML, Excel, CSV, text, URLs, and more.
30+
- **Scale to long documents:** Long and complex documents are handled via [PageIndex](https://github.com/VectifyAI/PageIndex) tree indexing, enabling accurate, vectorless context-aware retrieval.
31+
- **Native multi-modality:** Retrieves and understands figures, tables, and images, not just text.
32+
- **Compiled Wiki:** The LLM compiles your documents into summaries, concept pages, entity pages, and cross-links, all kept in sync.
33+
- **Query & Chat:** One-off questions or multi-turn conversations over your wiki, with persisted sessions you can resume.
34+
- **Skill Factory:** Distills redistributable agent skills from your wiki.
35+
- **Obsidian compatible:** Wiki is plain `.md` files with `[[wikilinks]]`. Open in Obsidian for graph view and browsing.
3636

3737
# 🚀 Getting Started
3838

@@ -162,7 +162,7 @@ OpenKB commands fall into two layers: the **wiki foundation** (compile + manage
162162
| Command | Description |
163163
|---|---|
164164
| `openkb init` | Initialize a new knowledge base (interactive) |
165-
| <code>openkb&nbsp;add&nbsp;&lt;file_or_dir_or_URL&gt;</code> | Add files, directories, or URLs and compile to wiki. URL content type (PDF or HTML) is auto-detected |
165+
| <code>openkb&nbsp;add&nbsp;&lt;file_or_dir_or_URL&gt;</code> | Add files, directories, or URLs and compile to wiki. The URL content type (PDF or HTML) is auto-detected. |
166166
| `openkb list` | List indexed documents and concepts |
167167
| `openkb status` | Show knowledge base stats |
168168
| `openkb watch` | Watch `raw/` and auto-compile new files |
@@ -241,7 +241,7 @@ Inside a chat, type `/` to access slash commands (Tab to complete).
241241

242242
### 🛠 Skill Factory — *Drop in a book; out comes a digital expert.*
243243

244-
The newest generator. `openkb skill new` distills an [agent skill](https://docs.claude.com/en/docs/build-with-claude/skills) from any subset of your wiki, a portable folder that major agents (Claude Code, Codex, etc.) install and load natively. Drop in a book's worth of papers; out comes a specialist that other agents can call on.
244+
The newest generator. `openkb skill new` distills an [agent skill](https://docs.claude.com/en/docs/build-with-claude/skills) from any subset of your wiki, a portable folder that major agents (Claude Code, Codex, etc.) can install and load natively. Drop in a book's worth of papers; out comes a specialist that other agents can call on.
245245

246246
```bash
247247
openkb skill new karpathy-thinking \
@@ -327,7 +327,7 @@ openkb skill rollback karpathy-thinking --to 2
327327

328328
### Settings
329329

330-
OpenKB settings are initialized by `openkb init` and are stored in `.openkb/config.yaml`:
330+
OpenKB settings are initialized by `openkb init` and stored in `.openkb/config.yaml`:
331331

332332
```yaml
333333
model: gpt-5.4 # LLM model (any LiteLLM-supported provider)
@@ -400,7 +400,7 @@ OpenKB's wiki is a directory of Markdown files with `[[wikilinks]]`. Obsidian re
400400

401401
### Using with Claude Code / Codex / Gemini CLI
402402

403-
OpenKB ships a `SKILL.md` so any agent CLI can read your compiled wiki. No extra runtime, no MCP setup, just install the skill once.
403+
OpenKB ships a `SKILL.md` so any agent can read your compiled wiki. No extra runtime, no MCP setup, just install the skill once.
404404

405405
<details>
406406
<summary><i>Claude Code:</i></summary>

0 commit comments

Comments
 (0)