compmark-vue 0.3.0 → 0.3.2

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 +16 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -23,7 +23,22 @@ Document an entire directory:
23
23
  npx compmark-vue ./src/components --out ./docs/api
24
24
  ```
25
25
 
26
- Add to your `package.json`:
26
+ ## Installation
27
+
28
+ ```sh
29
+ # npm
30
+ npm install -D compmark-vue
31
+
32
+ # pnpm
33
+ pnpm add -D compmark-vue
34
+
35
+ # yarn
36
+ yarn add -D compmark-vue
37
+ ```
38
+
39
+ > Requires Node.js >= 20
40
+
41
+ ## Add to your `package.json` post installation
27
42
 
28
43
  ```json
29
44
  {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "compmark-vue",
3
- "version": "0.3.0",
3
+ "version": "0.3.2",
4
4
  "description": "Auto-generate Markdown documentation from Vue 3 SFCs",
5
5
  "license": "MIT",
6
6
  "repository": "noopurphalak/compmark-vue",