Skip to content

Commit 4724ca5

Browse files
committed
Updated README with info about straight-from-git flattening
1 parent d535975 commit 4724ca5

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Coderoller is a Python utility that flattens a source code repository into a sin
88
- **Supports multiple file types** including `.py`, `.js`, `.jsx`, `.ts`, `.tsx`, `.swift`, `.go`, `.java`, `.c`, `.cpp`, `.h`, `.hpp`, `.cs`, `.lua`, `.rb`, `.php`, `.pl`, `.html`, `.css`, `.json`, `.toml`, `.md`, `.yaml`, `.yml`, `.conf`, `.ini`, and `.sh`.
99
- **Automatically includes README** files if present, placing it at the start of the flattened file.
1010
- **Excludes hidden files and directories** (those starting with a dot).
11+
- **Supports flattening directly from Git URLs** even if the repository is not cloned locally.
1112

1213
## Installation
1314

@@ -26,10 +27,16 @@ pipx install coderoller
2627
To flatten a source repository, use the `coderoller-flatten-repo` script.
2728

2829
```bash
29-
coderoller-flatten-repo /path/to/root/folder
30+
coderoller-flatten-repo /path/to/reponame
3031
```
3132

32-
This command will create a markdown file named `reponame.flat.md` in the current working directory, containing the flattened contents of the repository.
33+
To flatten a source repository directly from a Git URL, use the coderoller-flatten-repo script with the repository URL:
34+
35+
```bash
36+
coderoller-flatten-repo https://github.com/username/reponame.git
37+
```
38+
39+
Both commands will create a markdown file named `reponame.flat.md` in the current working directory, containing the flattened contents of the repository.
3340

3441
## License
3542

0 commit comments

Comments
 (0)