rskim 0.2.2 → 0.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -13,21 +13,33 @@ Think of it like `cat`, but smart about what code to show.
13
13
 
14
14
  ## Installation
15
15
 
16
- ### Via Cargo
16
+ ### Try it (no install required)
17
17
 
18
18
  ```bash
19
- cargo install rskim
19
+ npx rskim file.ts
20
20
  ```
21
21
 
22
- ### Via npm (coming soon)
22
+ ### Install globally (recommended for regular use)
23
23
 
24
24
  ```bash
25
+ # Via npm
25
26
  npm install -g rskim
27
+
28
+ # Via Cargo
29
+ cargo install rskim
26
30
  ```
27
31
 
32
+ > **Note**: Use `npx` for trying it out. For regular use, install globally to avoid npx overhead (~100-500ms per invocation).
33
+
28
34
  ## Quick Start
29
35
 
30
36
  ```bash
37
+ # Try it with npx (no install)
38
+ npx rskim file.ts
39
+
40
+ # Or install globally for better performance
41
+ npm install -g rskim
42
+
31
43
  # Read TypeScript with structure mode
32
44
  rskim file.ts
33
45
 
@@ -38,7 +50,7 @@ rskim file.py --mode signatures
38
50
  rskim file.rs | bat -l rust
39
51
 
40
52
  # Read from stdin
41
- cat code.ts | rskim - --language=type-script
53
+ cat code.ts | rskim - --language=typescript
42
54
  ```
43
55
 
44
56
  ## Features
@@ -222,7 +234,7 @@ For programmatic usage, see the [`rskim-core`](https://crates.io/crates/rskim-co
222
234
 
223
235
  - [Repository](https://github.com/dean0x/skim)
224
236
  - [Library Documentation](https://docs.rs/rskim-core)
225
- - [npm Package](https://www.npmjs.com/package/rskim) (coming soon)
237
+ - [npm Package](https://www.npmjs.com/package/rskim)
226
238
 
227
239
  ## License
228
240
 
Binary file
Binary file
Binary file
package/bin/rskim.js CHANGED
@@ -25,7 +25,7 @@ function getBinaryPath() {
25
25
  }
26
26
 
27
27
  console.error('ERROR: rskim binary not found for your platform');
28
- console.error(\`Platform: \${platform}, Architecture: \${arch}\`);
28
+ console.error(`Platform: ${platform}, Architecture: ${arch}`);
29
29
  console.error('Please report this issue at: https://github.com/dean0x/skim/issues');
30
30
  process.exit(1);
31
31
  }
Binary file
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "rskim",
3
- "version": "0.2.2",
3
+ "version": "0.2.4",
4
4
  "description": "Smart code reader - streaming code transformation for AI agents",
5
5
  "bin": {
6
6
  "rskim": "./bin/rskim.js"