Skip to content

Commit 9f2cdf9

Browse files
committed
fix(readme): Show file sizes and add key file descriptions in project structure
1 parent 978299b commit 9f2cdf9

File tree

3 files changed

+25
-41
lines changed

3 files changed

+25
-41
lines changed

CHANGELOG.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22

33
## [1.0.4](https://github.com/ioncakephper/repo-description/compare/v1.0.3...v1.0.4) (2025-11-02)
44

5-
65
### Bug Fixes
76

8-
* **config:** prevent empty markdown-magic transform entry ([451d95c](https://github.com/ioncakephper/repo-description/commit/451d95c2376d7bf89a273cee5b31a9ab99ba8549))
7+
- **config:** prevent empty markdown-magic transform entry ([451d95c](https://github.com/ioncakephper/repo-description/commit/451d95c2376d7bf89a273cee5b31a9ab99ba8549))
98

109
## [1.0.3](https://github.com/ioncakephper/repo-description/compare/v1.0.2...v1.0.3) (2025-11-02)
1110

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -266,35 +266,35 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
266266

267267
## Project Structure
268268

269-
<!-- doc-gen fileTreeExtended showSize=false showDescriptions=true descriptionsFile=_descriptions.json -->
269+
<!-- doc-gen fileTreeExtended showSize=true showDescriptions=true descriptionsFile=_descriptions.json -->
270270

271271
```
272272
repo-description/
273273
├── __tests__
274-
│ ├── .gitkeep
275-
│ └── cli.test.js # Description unavailable.
274+
│ ├── .gitkeep (66 B)
275+
│ └── cli.test.js (792 B)
276276
├── .qodo
277277
│ ├── agents
278278
│ └── workflows
279279
├── src
280-
│ ├── cli.js # Description unavailable.
281-
│ ├── describe.js # Description unavailable.
282-
│ ├── index.js # Description unavailable.
283-
│ └── utils.js # Description unavailable.
284-
├── _descriptions.json
285-
├── .env # Defines the GROQ_API_KEY environment variable for authentication.
286-
├── .gitignore
287-
├── .prettierrc.json # Description unavailable.
288-
├── babel.config.js # Description unavailable.
289-
├── CHANGELOG.md # Description unavailable.
290-
├── CONTRIBUTING.md # Description unavailable.
291-
├── eslint.config.js # Description unavailable.
292-
├── LICENSE # Description unavailable.
293-
├── md.config.js # Description unavailable.
294-
├── package-lock.json # Description unavailable.
295-
├── package.json # Description unavailable.
296-
├── README.md # Description unavailable.
297-
└── RULES_OF_CONDUCT.md # Description unavailable.
280+
│ ├── cli.js (2.7 KB) # Handles command-line interface parsing and execution.
281+
│ ├── describe.js (8.3 KB)
282+
│ ├── index.js (308 B)
283+
│ └── utils.js (0 B)
284+
├── _descriptions.json (221 B)
285+
├── .env (69 B)
286+
├── .gitignore (2.1 KB)
287+
├── .prettierrc.json (563 B)
288+
├── babel.config.js (92 B)
289+
├── CHANGELOG.md (2.3 KB)
290+
├── CONTRIBUTING.md (2.9 KB)
291+
├── eslint.config.js (1.1 KB)
292+
├── LICENSE (1.0 KB)
293+
├── md.config.js (438 B)
294+
├── package-lock.json (297.6 KB)
295+
├── package.json (3.1 KB) # Defines project metadata, scripts, and dependencies.
296+
├── README.md (16.6 KB) # Provides an overview of the repository and its usage.
297+
└── RULES_OF_CONDUCT.md (4.9 KB)
298298
```
299299

300300
<!-- end-doc-gen -->

_descriptions.json

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,5 @@
11
{
2-
".env": "Defines the GROQ_API_KEY environment variable for authentication.",
3-
".prettierrc.json": "Description unavailable.",
4-
".vscode/launch.json": "Description unavailable.",
5-
"babel.config.js": "Description unavailable.",
6-
"CHANGELOG.md": "Description unavailable.",
7-
"CONTRIBUTING.md": "Description unavailable.",
8-
"eslint.config.js": "Description unavailable.",
9-
"LICENSE": "Description unavailable.",
10-
"md.config.js": "Description unavailable.",
11-
"package-lock.json": "Description unavailable.",
12-
"package.json": "Description unavailable.",
13-
"README.md": "Description unavailable.",
14-
"RULES_OF_CONDUCT.md": "Description unavailable.",
15-
"src/cli.js": "Description unavailable.",
16-
"src/describe.js": "Description unavailable.",
17-
"src/index.js": "Description unavailable.",
18-
"src/utils.js": "Description unavailable.",
19-
"__tests__/cli.test.js": "Description unavailable."
2+
"README.md": "Provides an overview of the repository and its usage.",
3+
"src/cli.js": "Handles command-line interface parsing and execution.",
4+
"package.json": "Defines project metadata, scripts, and dependencies."
205
}

0 commit comments

Comments
 (0)