scaffold-doc-cli 1.0.0 → 1.0.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 +16 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,7 +9,22 @@ A CLI tool to scaffold standardized documentation structure for Motin projects,
|
|
|
9
9
|
- 🤖 Embeds AI-friendly context and instructions in Markdown comments.
|
|
10
10
|
- 📦 Optional GitHub Workflow for automated AI documentation updates.
|
|
11
11
|
|
|
12
|
-
## Installation & Usage
|
|
12
|
+
## Installation & Usage
|
|
13
|
+
|
|
14
|
+
You can use the tool directly with `npx` without installing it globally:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npx scaffold-doc-cli
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Or install it globally:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm install -g scaffold-doc-cli
|
|
24
|
+
init-doc
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Development
|
|
13
28
|
|
|
14
29
|
1. Clone the repository.
|
|
15
30
|
2. Install dependencies:
|
|
@@ -29,18 +44,6 @@ A CLI tool to scaffold standardized documentation structure for Motin projects,
|
|
|
29
44
|
init-doc
|
|
30
45
|
```
|
|
31
46
|
|
|
32
|
-
## Publishing to NPM
|
|
33
|
-
|
|
34
|
-
1. Login to NPM:
|
|
35
|
-
```bash
|
|
36
|
-
npm login
|
|
37
|
-
```
|
|
38
|
-
2. Publish the package:
|
|
39
|
-
```bash
|
|
40
|
-
npm publish
|
|
41
|
-
```
|
|
42
|
-
*Note: Ensure the `name` in `package.json` is unique on NPM or scoped (e.g., `@motin/doc-cli`).*
|
|
43
|
-
|
|
44
47
|
## Generated Structure
|
|
45
48
|
|
|
46
49
|
```
|