Skip to content

Commit e10c199

Browse files
authored
Update README.md
add sdk explanation
1 parent fb8ddd7 commit e10c199

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,30 @@
3030
</p>
3131

3232

33-
## Quick Install
33+
## Quick Install
3434

35-
With cargo:
35+
CLI with cargo 🦀
3636

3737
```bash
3838
cargo install code2prompt
3939
```
40-
<!--
41-
With python:
40+
41+
SDK with pip 🐍
4242

4343
```bash
4444
pip install code2prompt-rs
4545
```
46-
!-->
4746

4847
## How is it useful?
4948

49+
**CLI**
50+
5051
`code2prompt` makes it easy to generate prompts for LLMs from your codebase. It traverses the directory, builds a tree structure, and collects information about each file. You can customize the prompt generation using Handlebars templates. The generated prompt is automatically copied to your clipboard and can also be saved to an output file. `code2prompt` helps streamline the process of creating LLM prompts for code analysis, generation, and other tasks.
5152

53+
**SDK**
54+
55+
`code2prompt` python binding helps programs to interact with codebase. It's useful to ingest codebase for AI agent or automation scripts.
56+
5257
## Documentation 📚
5358

5459
Check our online [documentation](https://odancona.github.io/code2prompt/) for usage
@@ -134,7 +139,7 @@ nix-env -iA nixpkgs.code2prompt
134139
nix profile install nixpkgs#code2prompt
135140
```
136141

137-
## Usages
142+
## Usage
138143

139144
Generate a prompt from a codebase directory:
140145

0 commit comments

Comments
 (0)