synset 0.9.0 → 0.9.2

package/README.md

@@ -1,19 +1,50 @@
+[![npm version](https://img.shields.io/npm/v/synset.svg)](https://www.npmjs.com/package/synset)
+
 # synset
 
 WordNet dictionary parser with Zod validation, query utilities, and CLI.
 
-## Install
+## Usage
+
+### CLI
 
 ```bash
-npm install synset
-# or
-bun add synset
+# Run without installing
+bunx synset define dog
+
+# List synonyms
+bunx synset synonyms happy
+
+# Show hypernyms (more general terms)
+bunx synset hypernyms dog
+
+# Show all relations
+bunx synset related computer
+
+# Pre-download WordNet data
+bunx synset fetch
+
+# Export to SQLite database
+bunx synset export-sqlite dictionary.db
+
+# Use local file instead of cache
+bunx synset define dog --file ./path/to/english-wordnet-{YEAR}.xml
 ```
 
-## Usage
+> Or install globally:
+> ```bash
+> bun install -g synset
+> synset define dog
+> ```
 
 ### Library
 
+```bash
+npm install synset
+# or
+bun add synset
+```
+
 ```ts
 import {
   fetchWordNet,
@@ -32,9 +63,6 @@ console.log(`Loaded WordNet ${version}`)
 // Or load from local file
 const lexicon = await loadWordNet('./path/to/english-wordnet-{YEAR}.xml')
 
-// Or request specific version
-const { lexicon } = await fetchWordNet({ version: '2024' })
-
 // Build index for fast lookups
 const index = buildIndex(lexicon)
 
@@ -52,45 +80,32 @@ findSynsets(index, 'bank')
 // [Synset for "financial institution", Synset for "river bank", ...]
 ```
 
-### CLI
-
-```bash
-# Show definitions
-synset define dog
-
-# List synonyms
-synset synonyms happy
-
-# Show hypernyms (more general terms)
-synset hypernyms dog
-
-# Show all relations
-synset related computer
-
-# Pre-download WordNet data
-synset fetch
-
-# Use local file instead of cache
-synset define dog --file ./path/to/english-wordnet-{YEAR}.xml
-```
-
-### Exports
+#### SQLite Export
 
 ```ts
-// Zod schemas (runtime validation)
-import { Lexicon, Synset, Sense, LexicalEntry } from 'synset'
-
-// TypeScript types
-import type { LexiconType, SynsetType, SenseType } from 'synset'
+import { exportToSQLite } from 'synset'
+
+// Export to SQLite (requires Bun runtime)
+exportToSQLite(lexicon, 'dictionary.db', {
+  onProgress: ({ phase, current, total }) => {
+    console.log(`${phase}: ${current}/${total}`)
+  }
+})
+```
 
-// Human-readable labels
-import { PartsOfSpeechLabels, SynsetRelationLabels } from 'synset'
+Schema:
+```
+words(id, word, word_display)
+synsets(id, pos, definition)
+word_synsets(word_id, synset_id)
 ```
 
 ## Runtime
 
 - **Bun**: Full support (recommended)
-- **Node.js 18+**: Supported for remote fetching. Local file parsing requires Bun due to `file://` URL fetch limitations.
+- **Node.js 18+**: Full support
+
+> **Note:** SQLite export (`exportToSQLite`, `export-sqlite`) requires Bun (uses `bun:sqlite`).
 
 ## Development