diff --git a/README.md b/README.md index 01831a34..d5e8bf0d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@

- -

-

-

README-AI

+ +

+

README-AI

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. - - - - - - - -
large-repo
default output (no options provided to cli) +
+ large-repo
+ default output (no options provided to cli)
flat
--badges flat --image black +
+ flat
+ --badges flat --image black
flat
--badges flat-square --offline +
+ flat
+ --badges flat-square --offline
plastic
--badges plastic --image grey +
+ plastic
+ --badges plastic --image grey
large-repo
--align left --badges flat --image purple +
+ large-repo
+ --align left --badges flat --image purple
skills-light
--badges skills-light --image grey +
+ skills-light
+ --badges skills-light --image grey
skills
--align left --badges skills --image yellow +
+ skills
+ --align left --badges skills --image yellow
-See the [Configuration](#-configuration) section below for the complete list of CLI options and settings.
- +See the Configuration section below for the complete list of CLI options and settings.
+
📑 Codebase Documentation
- - + - - +
Repository Structure
+
+ Repository Structure

A directory tree structure is created and displayed in the README. Implemented using pure Python (tree.py).

tree + tree +
Codebase Summaries + + Codebase Summaries

File summaries generated using LLM APIs, and are formatted and grouped by directory in markdown tables.

summaries + summaries +
- +
📍 Overview & Features Table
@@ -171,7 +189,7 @@ See the [Configuration](#-configuration) section below for the complete list of
- +
🚀 Dynamic Quick Start Guides
@@ -182,11 +200,12 @@ See the [Configuration](#-configuration) section below for the complete list of - getting-started + getting-started +
- +
🤝 Contributing Guidelines, License, & More
@@ -201,7 +220,7 @@ See the [Configuration](#-configuration) section below for the complete list of
- +
🧩 Templates
This feature is currently under development. The template system will allow users to generate README files in different flavors, such as ai, data, web development, etc. @@ -230,7 +249,7 @@ See the [Configuration](#-configuration) section below for the complete list of
- +
🎨 Examples
diff --git a/examples/images/header-skills-dark.png b/examples/images/header-skills-dark.png index 725549f3..187f9acf 100644 Binary files a/examples/images/header-skills-dark.png and b/examples/images/header-skills-dark.png differ