Skip to content

Commit

Permalink
Fix mismatched html tags.
Browse files Browse the repository at this point in the history
  • Loading branch information
eli64s committed Jan 4, 2024
1 parent b18fdc6 commit 23870fe
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 24 deletions.
67 changes: 43 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
<p align="center">
<img src="https://img.icons8.com/?size=512&id=55494&format=png" width="100" /><img src="https://img.icons8.com/?size=512&id=kTuxVYRKeKEY&format=png" width="100" />
</p>
<p align="center">
<h1 align="center">README-AI</h1>
<img src="https://img.icons8.com/?size=512&id=55494&format=png" width="100">
<img src="https://img.icons8.com/?size=512&id=kTuxVYRKeKEY&format=png" width="100">
</p>
<h1 align="center">README-AI</h1>
<p align="center">
<em>Auto-generate detailed and structured README files, powered by AI.</em>
</p>
Expand Down Expand Up @@ -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.

<table>
<tr>
<td colspan="2" align="center"><img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-default.png" alt="large-repo" width="800"/><br><code>default output (no options provided to cli)</code>
<td colspan="2" align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-default.png" alt="large-repo" width="800"/><br>
<code>default output (no options provided to cli)</code>
</td>
</tr>
<tr>
<td align="center"><img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-flat.png" alt="flat" width="400"/><br><code>--badges flat --image black</code>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-flat.png" alt="flat" width="400"/><br>
<code>--badges flat --image black</code>
</td>
<td align="center"><img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-offline.png" alt="flat" width="400"/><br><code>--badges flat-square --offline</code>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-offline.png" alt="flat" width="400"/><br>
<code>--badges flat-square --offline</code>
</td>
</tr>
<tr>
<td align="center"><img src="https://github.com/eli64s/readme-ai/blob/main/examples/images/header-plastic.png" alt="plastic" width="400"/><br><code>--badges plastic --image grey</code>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-plastic.png" alt="plastic" width="400"/><br>
<code>--badges plastic --image grey</code>
</td>
<td align="center"><img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-purple.png" alt="large-repo" width="400"/><br><code>--align left --badges flat --image purple</code>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-purple.png" alt="large-repo" width="400"/><br>
<code>--align left --badges flat --image purple</code>
</td>
</tr>
<tr>
<td align="center"><img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-skills-light.png" alt="skills-light" width="400"/><br><code>--badges skills-light --image grey</code>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-skills-light.png" alt="skills-light" width="400"/><br>
<code>--badges skills-light --image grey</code>
</td>
<td align="center"><img src="https://github.com/eli64s/readme-ai/blob/main/examples/images/header-skills-dark.png" alt="skills" width="400"/><br><code>--align left --badges skills --image yellow</code>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-skills-dark.png" alt="skills" width="400"/><br>
<code>--align left --badges skills --image yellow</code>
</td>
</tr>
</table>

See the [Configuration](#-configuration) section below for the complete list of CLI options and settings.<br>
<!---->
See the <a href="#-configuration">Configuration</a> section below for the complete list of CLI options and settings.<br>
<!-- -->
<details closed>
<summary>📑 Codebase Documentation</summary>
<br>
<table>
<tr>
<td><b>Repository Structure</b><br>
<td>
<b>Repository Structure</b><br>
<p>A directory tree structure is created and displayed in the README. Implemented using pure Python (<a href="https://github.com/eli64s/readme-ai/blob/main/readmeai/markdown/tree.py">tree.py</a>).</p>
</td>
</tr>
<tr>
<td align="center"><img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/code-directory-tree.png" alt="tree" width="700" /></td>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/code-directory-tree.png" alt="tree" width="700" />
</td>
</tr>
<tr>
<td style="padding-top:20px;">Codebase Summaries</b>
<td style="padding-top:20px;">
<b>Codebase Summaries</b>
<br>
<p>File summaries generated using LLM APIs, and are formatted and grouped by directory in markdown tables.</p>
</td>
</tr>
<tr>
<td align="center"><img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/code-summary-table.png" alt="summaries" width="700" /></td>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/code-summary-table.png" alt="summaries" width="700" />
</td>
</tr>
</table>
</details>
<!---->
<!-- -->
<details closed>
<summary>📍 Overview & Features Table</summary>
<br>
Expand All @@ -171,7 +189,7 @@ See the [Configuration](#-configuration) section below for the complete list of
</tr>
</table>
</details>
<!---->
<!-- -->
<details closed>
<summary>🚀 Dynamic Quick Start Guides</summary>
<br>
Expand All @@ -182,11 +200,12 @@ See the [Configuration](#-configuration) section below for the complete list of
</td>
</tr>
<tr>
<td align="center"><img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/getting-started.png" alt="getting-started" width="700" /></td>
<td align="center"><img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/getting-started.png" alt="getting-started" width="700" />
</td>
</tr>
</table>
</details>
<!---->
<!-- -->
<details closed>
<summary>🤝 Contributing Guidelines, License, & More</summary>
<br>
Expand All @@ -201,7 +220,7 @@ See the [Configuration](#-configuration) section below for the complete list of
</tr>
</table>
</details>
<!---->
<!-- -->
<details closed>
<summary>🧩 Templates</summary>
<br>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.
Expand Down Expand Up @@ -230,7 +249,7 @@ See the [Configuration](#-configuration) section below for the complete list of
</tr>
</table>
</details>
<!---->
<!-- -->
<details closed>
<summary>🎨 Examples</summary>
<br>
Expand Down
Binary file modified examples/images/header-skills-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 23870fe

Please sign in to comment.