Add subdirectory URL syntax documentation to README (#254)

pokey · filipchristiansen · web-flow · commit 52966287c463 · 2025-06-22T01:06:32.000+02:00
* Add subdirectory URL syntax documentation to README

Document how to access specific subdirectories using GitHub tree URLs with gitingest repo examples.


Co-authored-by: Filip Christiansen &lt;22807962+filipchristiansen@users.noreply.github.com&gt;
diff --git a/README.md b/README.md
@@ -83,6 +83,9 @@ gitingest /path/to/directory
 
 # From URL
 gitingest https://github.com/cyclotruc/gitingest
+
+# or from specific subdirectory
+gitingest https://github.com/cyclotruc/gitingest/tree/main/src/gitingest/utils
 ```
 
 For private repositories, use the `--token/-t` option.
@@ -117,6 +120,9 @@ summary, tree, content = ingest("path/to/directory")
 
 # or from URL
 summary, tree, content = ingest("https://github.com/cyclotruc/gitingest")
+
+# or from a specific subdirectory
+summary, tree, content = ingest("https://github.com/cyclotruc/gitingest/tree/main/src/gitingest/utils")
 ```
 
 For private repositories, you can pass a token:
