compmark-vue 0.3.1 → 0.3.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 +15 -15
  2. package/package.json +13 -1
package/README.md CHANGED
@@ -9,6 +9,20 @@
9
9
 
10
10
  Auto-generate Markdown documentation from Vue 3 SFCs. Zero configuration required.
11
11
 
12
+ ## Quick Start
13
+
14
+ Document a single component:
15
+
16
+ ```sh
17
+ npx compmark-vue ./src/components/Button.vue
18
+ ```
19
+
20
+ Document an entire directory:
21
+
22
+ ```sh
23
+ npx compmark-vue ./src/components --out ./docs/api
24
+ ```
25
+
12
26
  ## Installation
13
27
 
14
28
  ```sh
@@ -24,21 +38,7 @@ yarn add -D compmark-vue
24
38
 
25
39
  > Requires Node.js >= 20
26
40
 
27
- ## Quick Start
28
-
29
- Document a single component:
30
-
31
- ```sh
32
- npx compmark-vue ./src/components/Button.vue
33
- ```
34
-
35
- Document an entire directory:
36
-
37
- ```sh
38
- npx compmark-vue ./src/components --out ./docs/api
39
- ```
40
-
41
- Add to your `package.json`:
41
+ ## Add to your `package.json` post installation
42
42
 
43
43
  ```json
44
44
  {
package/package.json CHANGED
@@ -1,7 +1,19 @@
1
1
  {
2
2
  "name": "compmark-vue",
3
- "version": "0.3.1",
3
+ "version": "0.3.3",
4
4
  "description": "Auto-generate Markdown documentation from Vue 3 SFCs",
5
+ "keywords": [
6
+ "compmark",
7
+ "compmark-vue",
8
+ "component",
9
+ "docs-generator",
10
+ "documentation",
11
+ "markdown",
12
+ "sfc",
13
+ "vue",
14
+ "vue-documentation",
15
+ "vue3"
16
+ ],
5
17
  "license": "MIT",
6
18
  "repository": "noopurphalak/compmark-vue",
7
19
  "bin": {