Skip to content

Commit cfe9061

Browse files
committed
Updating README.md; Formalize v0.0.3
1 parent 8b77541 commit cfe9061

5 files changed

Lines changed: 22 additions & 7 deletions

File tree

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
/ /___ | (_) || (_| || __/ / /\/\ \ / /_//
88
\____/ \___/ \__,_| \___| \/ \//___,'
99
10-
Ver. 0.0.3b
10+
Ver. 0.0.3
1111
```
1212

1313
# CodeMD
@@ -21,7 +21,22 @@ Ver. 0.0.3b
2121

2222
## 📝 Overview
2323

24-
Tired of copying code files one by one? CodeMD instantly collects all relevant code in Markdown format and copies it to your clipboard - ready for ChatGPT, Claude, or any LLM? CodeMD helps you convert your code files or entire codebase into a format that's optimal for code-related prompts with Large Language Models (LLMs) like GPT-4, Claude, and others. It automatically processes your code files and outputs them in a clean, markdown-formatted structure that's perfect for LLM interactions.
24+
Tired of copying code files one by one? CodeMD instantly collects all relevant code in Markdown format and copies it to your clipboard - ready for ChatGPT, Claude, or any LLM.
25+
26+
Whether you need to process a single script or an entire codebase, CodeMD automatically:
27+
- Formats your code into LLM-friendly markdown
28+
- Preserves file structure and syntax highlighting
29+
- Estimates token usage for GPT models
30+
- Copies everything to your clipboard
31+
32+
Perfect for developers who want to:
33+
- Get AI assistance with code review
34+
- Ask LLMs about specific implementations
35+
- Document and explain codebases
36+
- Debug complex issues with AI help
37+
38+
No more manual copying and pasting - just run CodeMD and start chatting with your favorite LLM!
39+
2540

2641
## ✨ Features
2742

@@ -42,7 +57,7 @@ Tired of copying code files one by one? CodeMD instantly collects all relevant c
4257
- Direct copy-to-clipboard support
4358
- Multiple output options
4459

45-
### 🎉 Recent Updates (0.0.3b)
60+
### 🎉 Recent Updates (0.0.3)
4661

4762
-**NEW**: Single file processing support
4863
-**NEW**: Configurable output display (use `--print` to show output)

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "codemd"
7-
version = "0.0.3b"
7+
version = "0.0.3"
88
authors = [
99
{ name = "Peilin Yu", email = "peilin_yu@brown.edu" },
1010
]

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
setup(
1212
name="codemd",
13-
version="0.0.3b",
13+
version="0.0.3",
1414
author="Peilin Yu",
1515
author_email="peilin_yu@brown.edu",
1616
description="Transform code repositories into markdown-formatted strings ready for LLM prompting",

src/codemd/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
from .cli import main
22
from .scanner import CodeScanner
33

4-
__version__ = "0.0.3b"
4+
__version__ = "0.0.3"
55
__all__ = ["CodeScanner", "main"]

src/codemd/cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ def format_token_info(token_count: int, model_name: str) -> str:
215215

216216
def main() -> int:
217217
print(BANNER)
218-
print("Version 0.0.3b")
218+
print("Version 0.0.3")
219219
print("Transform your code into LLM-ready prompts and automatically copy them to your clipboard!\n")
220220

221221
try:

0 commit comments

Comments
 (0)