readme-author 0.1.2 → 0.1.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.
- package/README.md +38 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,11 +1,43 @@
|
|
|
1
1
|
# readme-author
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
|
|
4
4
|
|
|
5
|
+
A zero-config CLI tool that analyzes your Node.js project and automatically generates a structured `README.md`.
|
|
5
6
|
|
|
6
|
-
|
|
7
|
-
npm install
|
|
7
|
+
Run a single command inside your project folder and get a clean, formatted README in seconds.
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Why?
|
|
12
|
+
|
|
13
|
+
Most developers either:
|
|
14
|
+
|
|
15
|
+
- Skip writing READMEs
|
|
16
|
+
- Write incomplete documentation
|
|
17
|
+
- Forget installation and execution steps
|
|
18
|
+
- Keep outdated instructions
|
|
19
|
+
|
|
20
|
+
`readme-author` removes that friction by generating a consistent, structured README directly from your project configuration.
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Features (v0.1.x – MVP)
|
|
25
|
+
|
|
26
|
+
- Detects Node.js projects
|
|
27
|
+
- Reads `package.json`
|
|
28
|
+
- Extracts project name and description
|
|
29
|
+
- Lists important npm scripts
|
|
30
|
+
- Generates installation instructions
|
|
31
|
+
- Creates or updates `README.md`
|
|
32
|
+
- Prompts before overwriting existing README files
|
|
33
|
+
|
|
34
|
+
No setup. No configuration. No manual input.
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## Installation & Usage
|
|
39
|
+
|
|
40
|
+
No global install required.
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npx -y readme-author@latest .
|