diff --git a/README.md b/README.md index 01831a34..d5e8bf0d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@
- -
--
Auto-generate detailed and structured README files, powered by AI.
@@ -95,58 +94,77 @@ The header section is built using repository metadata and CLI options. Key featu - **Table of Contents/Quick Links**: Links to the different sections of the README file. Below are a few examples of README headers generated by the readme-ai tool. -default output (no options provided to cli)
+ |
+ + default output (no options provided to cli)
|
||
--badges flat --image black
+ |
+ + --badges flat --image black
|
- --badges flat-square --offline
+ |
+ + --badges flat-square --offline
|
--badges plastic --image grey
+ |
+ + --badges plastic --image grey
|
- --align left --badges flat --image purple
+ |
+ + --align left --badges flat --image purple
|
--badges skills-light --image grey
+ |
+ + --badges skills-light --image grey
|
- --align left --badges skills --image yellow
+ |
+ + --align left --badges skills --image yellow
|
Repository Structure + |
+ Repository Structure A directory tree structure is created and displayed in the README. Implemented using pure Python (tree.py). |
+ | + + |
Codebase Summaries + |
+ Codebase Summaries
File summaries generated using LLM APIs, and are formatted and grouped by directory in markdown tables. |
+ | + + |