docs-for-me 0.1.0 → 0.1.1
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 +25 -12
- package/package.json +1 -1
- package/prebuilt/win32-x64/docs-for-me.exe +0 -0
package/README.md
CHANGED
|
@@ -20,21 +20,37 @@ or deleted after review.
|
|
|
20
20
|
|
|
21
21
|
## Install
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
Install it with npm:
|
|
24
24
|
|
|
25
25
|
```powershell
|
|
26
|
-
|
|
26
|
+
npm install -g docs-for-me
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Then run it anywhere:
|
|
30
|
+
|
|
31
|
+
```powershell
|
|
32
|
+
docs-for-me --help
|
|
33
|
+
docs-for-me changes --ai none --out changes-guide.md
|
|
27
34
|
```
|
|
28
35
|
|
|
29
|
-
|
|
36
|
+
You can also install it inside one project:
|
|
30
37
|
|
|
31
38
|
```powershell
|
|
32
39
|
npm install --save-dev docs-for-me
|
|
33
|
-
|
|
40
|
+
npm exec docs-for-me changes --ai none --out changes-guide.md
|
|
34
41
|
```
|
|
35
42
|
|
|
36
|
-
|
|
37
|
-
|
|
43
|
+
For a one-time trial without installing globally:
|
|
44
|
+
|
|
45
|
+
```powershell
|
|
46
|
+
npx docs-for-me --help
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Important: `npx docs-for-me` runs the package once. It does not permanently add
|
|
50
|
+
`docs-for-me` as a command. If you want to type `docs-for-me ...` directly,
|
|
51
|
+
install it globally with `npm install -g docs-for-me`.
|
|
52
|
+
|
|
53
|
+
Users do not need to install Python, pip, or pipx.
|
|
38
54
|
|
|
39
55
|
The first npm release ships with a bundled Windows x64 executable. macOS and
|
|
40
56
|
Linux builds can be added after the Windows release flow is stable.
|
|
@@ -148,7 +164,7 @@ prebuilt/win32-x64/docs-for-me.exe
|
|
|
148
164
|
```
|
|
149
165
|
|
|
150
166
|
When publishing to npm, that executable is included so users can run
|
|
151
|
-
`
|
|
167
|
+
`docs-for-me ...` after `npm install -g docs-for-me` without setting up Python.
|
|
152
168
|
|
|
153
169
|
If that line appears, `docs-for-me` fell back to static mode.
|
|
154
170
|
|
|
@@ -205,13 +221,10 @@ The code is provider-based, so more providers can be added later.
|
|
|
205
221
|
|
|
206
222
|
## Project Status
|
|
207
223
|
|
|
208
|
-
`docs-for-me` is early-stage. It
|
|
209
|
-
not published yet.
|
|
224
|
+
`docs-for-me` is early-stage. It is published on npm for Windows x64 first.
|
|
210
225
|
|
|
211
226
|
Good next steps:
|
|
212
227
|
|
|
213
|
-
- improve README and packaging metadata
|
|
214
|
-
- add a `LICENSE`
|
|
215
228
|
- add config file support
|
|
216
229
|
- add more AI providers
|
|
217
|
-
-
|
|
230
|
+
- add macOS and Linux npm builds
|
package/package.json
CHANGED
|
Binary file
|