@jarkkojs/readseek 0.12.1 → 0.12.3

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.
Files changed (2) hide show
  1. package/README.md +24 -7
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -1,16 +1,33 @@
1
1
  # @jarkkojs/readseek
2
2
 
3
- ReadSeek command-line tool. Installs the binary for the current platform through an
4
- optional platform package (Linux x64/arm64, macOS arm64, or Windows x64).
3
+ ReadSeek command-line tool for structural navigation of source files and
4
+ documents.
5
+
6
+ ## Install
5
7
 
6
8
  ```sh
7
9
  npm install --global @jarkkojs/readseek
8
10
  readseek --version
9
11
  ```
10
12
 
11
- On Linux, the launcher runs the packaged AppImage with
12
- `APPIMAGE_EXTRACT_AND_RUN=1`, so FUSE is not required. For TypeScript contracts
13
- and programmatic binary resolution, install `@jarkkojs/readseek-api` separately.
13
+ The launcher installs the binary for the current platform through an optional
14
+ platform package (Linux x64/arm64, macOS arm64, or Windows x64). On Linux it runs
15
+ the packaged AppImage with `APPIMAGE_EXTRACT_AND_RUN=1`, so FUSE is not required.
16
+
17
+ ## Usage
18
+
19
+ ```sh
20
+ readseek show src/main.cc
21
+ readseek grep 'Run\(' src
22
+ readseek search 'std::move($ARG)' src
23
+ readseek edit src --edits @migration.kdl
24
+ ```
25
+
26
+ Run `readseek --help` or see [readseek(1)](../readseek/man/man1/readseek.1).
27
+ Install [`@jarkkojs/readseek-api`](../readseek-api/README.md) for the TypeScript
28
+ API.
29
+
30
+ ## License
14
31
 
15
- The launcher is licensed under Apache 2.0; the platform binaries are licensed
16
- under LGPL-3.0-or-later.
32
+ The launcher is licensed under [Apache-2.0](LICENSE). The platform binaries are
33
+ licensed under LGPL-3.0-or-later.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jarkkojs/readseek",
3
- "version": "0.12.1",
3
+ "version": "0.12.3",
4
4
  "description": "ReadSeek CLI with optional platform-specific binaries",
5
5
  "license": "Apache-2.0",
6
6
  "homepage": "https://gitlab.com/jarkkojs/readseek#readme",
@@ -35,9 +35,9 @@
35
35
  "structural-search"
36
36
  ],
37
37
  "optionalDependencies": {
38
- "@jarkkojs/readseek-darwin-arm64": "0.12.1",
39
- "@jarkkojs/readseek-linux-arm64": "0.12.1",
40
- "@jarkkojs/readseek-linux-x64": "0.12.1",
41
- "@jarkkojs/readseek-win32-x64": "0.12.1"
38
+ "@jarkkojs/readseek-darwin-arm64": "0.12.3",
39
+ "@jarkkojs/readseek-linux-arm64": "0.12.3",
40
+ "@jarkkojs/readseek-linux-x64": "0.12.3",
41
+ "@jarkkojs/readseek-win32-x64": "0.12.3"
42
42
  }
43
43
  }