rskim 0.2.3 → 0.3.0

package/README.md

@@ -13,32 +13,44 @@ Think of it like `cat`, but smart about what code to show.
 
 ## Installation
 
-### Via Cargo
+### Try it (no install required)
 
 ```bash
-cargo install rskim
+npx skim file.ts
 ```
 
-### Via npm (coming soon)
+### Install globally (recommended for regular use)
 
 ```bash
+# Via npm
 npm install -g rskim
+
+# Via Cargo
+cargo install rskim
 ```
 
+> **Note**: Use `npx` for trying it out. For regular use, install globally to avoid npx overhead (~100-500ms per invocation).
+
 ## Quick Start
 
 ```bash
+# Try it with npx (no install)
+npx skim file.ts
+
+# Or install globally for better performance
+npm install -g rskim
+
 # Read TypeScript with structure mode
-rskim file.ts
+skim file.ts
 
 # Extract Python function signatures
-rskim file.py --mode signatures
+skim file.py --mode signatures
 
 # Pipe to syntax highlighter
-rskim file.rs | bat -l rust
+skim file.rs | bat -l rust
 
 # Read from stdin
-cat code.ts | rskim - --language=type-script
+cat code.ts | skim - --language=typescript
 ```
 
 ## Features
@@ -54,7 +66,7 @@ cat code.ts | rskim - --language=type-script
 ### Basic Usage
 
 ```bash
-rskim <FILE>
+skim <FILE>
 ```
 
 ### Options
@@ -76,7 +88,7 @@ Options:
 Removes function bodies while preserving signatures (70-80% reduction).
 
 ```bash
-rskim file.ts
+skim file.ts
 ```
 
 **Input:**
@@ -98,7 +110,7 @@ function add(a: number, b: number): number { /* ... */ }
 Extracts only function and method signatures (85-92% reduction).
 
 ```bash
-rskim file.py --mode signatures
+skim file.py --mode signatures
 ```
 
 **Input:**
@@ -119,7 +131,7 @@ def calculate_total(items: list[Item], tax_rate: float) -> Decimal:
 Extracts only type definitions (90-95% reduction).
 
 ```bash
-rskim file.ts --mode types
+skim file.ts --mode types
 ```
 
 **Input:**
@@ -147,7 +159,7 @@ interface User {
 Returns original code unchanged (0% reduction).
 
 ```bash
-rskim file.rs --mode full
+skim file.rs --mode full
 ```
 
 ## Examples
@@ -156,37 +168,37 @@ rskim file.rs --mode full
 
 ```bash
 # Get overview of all TypeScript files
-find src -name '*.ts' -exec rskim {} \;
+find src -name '*.ts' -exec skim {} \;
 
 # Extract all Python function signatures
-rskim app.py --mode signatures > api.txt
+skim app.py --mode signatures > api.txt
 
 # Review Rust types
-rskim lib.rs --mode types | less
+skim lib.rs --mode types | less
 ```
 
 ### Prepare code for LLMs
 
 ```bash
 # Reduce token count before sending to GPT
-rskim large_file.ts | wc -w
+skim large_file.ts | wc -w
 # Output: 150 (was 600)
 
 # Get just the API surface
-rskim server.py --mode signatures | pbcopy
+skim server.py --mode signatures | pbcopy
 ```
 
 ### Pipe workflows
 
 ```bash
 # Skim and highlight
-rskim file.rs | bat -l rust
+skim file.rs | bat -l rust
 
 # Skim and search
-rskim file.ts | grep "interface"
+skim file.ts | grep "interface"
 
 # Skim multiple files
-cat *.py | rskim - --language=python
+cat *.py | skim - --language=python
 ```
 
 ## Supported Languages
@@ -222,7 +234,7 @@ For programmatic usage, see the [`rskim-core`](https://crates.io/crates/rskim-co
 
 - [Repository](https://github.com/dean0x/skim)
 - [Library Documentation](https://docs.rs/rskim-core)
-- [npm Package](https://www.npmjs.com/package/rskim) (coming soon)
+- [npm Package](https://www.npmjs.com/package/rskim)
 
 ## License
 

package/bin/{rskim.js → skim.js}

@@ -7,9 +7,9 @@ function getBinaryPath() {
   const platform = process.platform;
   const arch = process.arch;
 
-  let binaryName = 'rskim';
+  let binaryName = 'skim';
   if (platform === 'win32') {
-    binaryName = 'rskim.exe';
+    binaryName = 'skim.exe';
   }
 
   // Try to find the binary in the package
@@ -24,7 +24,7 @@ function getBinaryPath() {
     }
   }
 
-  console.error('ERROR: rskim binary not found for your platform');
+  console.error('ERROR: skim binary not found for your platform');
   console.error(`Platform: ${platform}, Architecture: ${arch}`);
   console.error('Please report this issue at: https://github.com/dean0x/skim/issues');
   process.exit(1);

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "rskim",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "description": "Smart code reader - streaming code transformation for AI agents",
   "bin": {
-    "rskim": "./bin/rskim.js"
+    "skim": "./bin/skim.js"
   },
   "repository": {
     "type": "git",