Skip to content

Commit 8a50960

Browse files
authored
Update README.md
1 parent d7dd0ae commit 8a50960

File tree

1 file changed

+1
-14
lines changed

1 file changed

+1
-14
lines changed

README.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,6 @@
11
# ~auto~md~
22

3-
~auto~md~ is a mini python based tool designed to convert various types of files and GitHub repositories into LLM-ready Markdown documents
4-
5-
6-
## Features
7-
8-
- **Supports Multiple File Types**: Processes `.txt`, `.md`, `.html`, `.css`, `.py`, `.js`, `.yaml`, `.yml`, `.json`, `.xml`, `.csv`, `.rst`, `.ini`, `.cfg`, `.log`, `.conf` files
9-
- **Handles Zip Files**: Automatically extracts and processes nested zip files
10-
- **GitHub Integration**: Clones and processes GitHub repositories
11-
- **Auto-Generated Output Filename**: Automatically sets the output file name based on the input file or repository
12-
- **AI-Optimized Markdown**: Generates Markdown with metadata, a table of contents, and consistent heading styles
13-
14-
# Auto MD
15-
16-
Auto MD is a Python tool that converts various file types and GitHub repositories into Markdown documents optimized for large language models (LLMs).
3+
~auto~md~ is a Python tool that converts various file types and GitHub repositories into Markdown documents (.md) optimized for large language models (LLMs)
174

185
![screen](auto-md-gui.png)
196

0 commit comments

Comments
 (0)