@lukoweb/apitogo 0.2.52 → 0.2.54

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
@@ -56,10 +56,23 @@ Because great API documentation frameworks should be:
56
56
  ### ⚡️ Quick start
57
57
 
58
58
  ```
59
- npx @lukoweb/apitogo@latest init
59
+ npx @lukoweb/apitogo@latest create
60
60
  ```
61
61
 
62
- _(You may later replace this with your own CLI if you build one)_
62
+ `create` asks for a project name and sets up a folder for it. Add `--template full` for every service and a small
63
+ Node.js backend, or `--dry-run` to see every file it would make first.
64
+
65
+ ### Install scripts (esbuild)
66
+
67
+ The portal build uses esbuild, which gets its binary in an install script. Newer npm versions warn about install
68
+ scripts and may skip them unless they are allowed (npm's `allow-scripts` setting, or `ignore-scripts`). The warning
69
+ for esbuild is expected: allow esbuild's script, or run it afterwards in the project folder:
70
+
71
+ ```
72
+ npm rebuild esbuild
73
+ ```
74
+
75
+ Without it the build stops with an esbuild error about a missing binary.
63
76
 
64
77
  ---
65
78