blytz 1.0.1 → 1.0.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 +105 -60
  2. package/package.json +17 -11
package/README.md CHANGED
@@ -1,60 +1,105 @@
1
- ## Description
2
-
3
- diglet is a Node.js application. Add a brief description of its purpose and what problem it solves.
4
-
5
- ## Installation
6
-
7
- Follow these steps to install the project:
8
-
9
- ```bash
10
- npm install
11
- ```
12
-
13
- ## Usage
14
-
15
- You can run the following scripts:
16
-
17
- - `npm start`
18
-
19
- ## Dependencies
20
-
21
- This project uses the following dependencies:
22
-
23
- - @octokit/app
24
- - @octokit/rest
25
- - dotenv
26
- - express
27
-
28
- ## Folder Structure
29
-
30
- Project structure:
31
-
32
- ```
33
- ├── .env
34
- ├── .gitignore
35
- ├── bin
36
- │ └── cli.js
37
- ├── LICENSE
38
- ├── package-lock.json
39
- ├── package.json
40
- ├── README.md
41
- ├── server
42
- │ ├── analytics.js
43
- │ ├── bot.js
44
- │ ├── github.js
45
- │ └── server.js
46
- └── src
47
- ├── fileTree.js
48
- ├── index.js
49
- ├── processReadme.js
50
- ├── projectReader.js
51
- └── template.js
52
- ```
53
-
54
- ## License
55
-
56
- Add your license information here.
57
-
58
- ## Built By
59
-
60
- Built with ❤️ by @Aryan Sharma
1
+ # blytz
2
+
3
+ `blytz` is a small Node.js CLI that creates and updates a project's `README.md` from local project metadata.
4
+
5
+ ## What it does
6
+
7
+ - Updates an existing `README.md`
8
+ - Creates a new `README.md` with `--init`
9
+ - Replaces an existing `README.md` with `--force`
10
+ - Reads `package.json` to build README sections automatically
11
+ - Generates a basic folder tree for the project structure section
12
+
13
+ ## Install
14
+
15
+ ```bash
16
+ npm install -g blytz
17
+ ```
18
+
19
+ If you are developing locally from this repository, you can link it instead:
20
+
21
+ ```bash
22
+ npm link
23
+ ```
24
+
25
+ ## Usage
26
+
27
+ Run the CLI from the root of the project you want to document:
28
+
29
+ ```bash
30
+ blytz
31
+ ```
32
+
33
+ You can also use the available flags:
34
+
35
+ ```bash
36
+ blytz --update
37
+ blytz --init
38
+ blytz --force
39
+ blytz --help
40
+ ```
41
+
42
+ ## Commands
43
+
44
+ ### `blytz`
45
+
46
+ Updates the existing `README.md` in the current directory.
47
+
48
+ ### `blytz --update`
49
+
50
+ Same as `blytz`. Refreshes the current `README.md` using the project metadata it finds.
51
+
52
+ ### `blytz --init`
53
+
54
+ Creates a new `README.md` only if one does not already exist.
55
+
56
+ If a README already exists, the CLI stops and suggests using `--force`.
57
+
58
+ ### `blytz --force`
59
+
60
+ Deletes the existing `README.md` and creates a fresh one.
61
+
62
+ ### `blytz --help`
63
+
64
+ Prints the usage summary.
65
+
66
+ ## Output sections
67
+
68
+ The generated README is built from these sections:
69
+
70
+ - Description
71
+ - Installation
72
+ - Usage
73
+ - Dependencies
74
+ - Folder Structure
75
+ - License
76
+ - Built By
77
+
78
+ ## Project requirements
79
+
80
+ For best results, include the following in your `package.json`:
81
+
82
+ - `name`
83
+ - `description`
84
+ - `author`
85
+ - `scripts`
86
+ - `dependencies`
87
+
88
+ The more metadata the CLI can read, the better the generated README will be.
89
+
90
+ ## Example
91
+
92
+ ```bash
93
+ cd my-project
94
+ blytz
95
+ ```
96
+
97
+ ## Notes
98
+
99
+ - The CLI expects to run in a folder that contains `package.json`
100
+ - The CLI reads the local `README.md` in the current directory
101
+ - The folder tree excludes `node_modules` and `.git`
102
+
103
+ ## License
104
+
105
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "blytz",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "bin": {
5
5
  "blytz": "./bin/cli.js"
6
6
  },
@@ -8,33 +8,39 @@
8
8
  "files": [
9
9
  "bin/",
10
10
  "src/",
11
- "README-NPM.md"
11
+ "bin/README-NPM.md"
12
12
  ],
13
13
  "description": "An automated CLI tool to fix and maintain project READMEs",
14
14
  "type": "module",
15
15
  "scripts": {
16
- "start": "node src/index.js"
16
+ "start": "node src/index.js",
17
+ "prepublishOnly": "node scripts/sync-readme.js prepublish",
18
+ "postpublish": "node scripts/sync-readme.js postpublish"
17
19
  },
18
20
  "repository": {
19
21
  "type": "git",
20
22
  "url": "git+https://github.com/AryanSharma48/readme-auto-fixer.git"
21
23
  },
22
24
  "keywords": [
25
+ "blytz",
23
26
  "cli",
24
27
  "readme",
28
+ "documentation",
25
29
  "automation",
26
30
  "github",
31
+ "npm",
27
32
  "bot",
28
33
  "readmefixer",
29
- "readmeauto",
34
+ "readme-generator",
35
+ "devtools",
36
+ "markdown",
37
+ "workflow",
38
+ "productivity",
39
+ "automated-docs",
40
+ "repository-manager",
41
+ "scaffold",
30
42
  "readme-maintainer",
31
- "readme-updater",
32
- "readme-helper",
33
- "readme-fixer",
34
- "readme-bot",
35
- "readme-automation",
36
- "readme-enhancer",
37
- "readme-improver"
43
+ "readme-updater"
38
44
  ],
39
45
  "author": "Aryan Sharma",
40
46
  "license": "MIT",