diff --git a/README.md b/README.md
index 40c82f5..98cb151 100644
--- a/README.md
+++ b/README.md
@@ -8,17 +8,17 @@ The generated site includes a repository index, per-repository README rendering,
GitGen generates a static HTML site with the following capabilities:
- - Repository index page listing all discovered Git repositories
+ - Repository index page which lists all discovered Git repositories
- Automatic discovery of Git repositories under a base directory
- Repository overview pages with rendered README files
+ - Markdown rendering for README.md files
- File tree listings based on the current `HEAD`
- Commit history (last 50 commits per repository)
- Detailed commit pages with:
- Full commit metadata
- Tags pointing at relevant commits
- Diffstat summary
- - Unified diff view (truncated for very large diffs)
- - Markdown rendering for README files
+ - Unified diff view (truncated to 500 lines)
- Safe HTML escaping throughout
- Parallel repository processing for faster generation
@@ -46,7 +46,7 @@ pip install markdown
```
GitRepoScanner:
- def __init__(self, base_path: str = "/home/cybr/Work/cybrkyd-git")
+ def __init__(self, base_path: str = "/path/to/Git/repositories")
```
3. Run the script:
@@ -57,7 +57,7 @@ python3 gitgen.py
4. The generated site will be written to the `git-website/` directory by default.
- Open `git-website/index.html` in a browser or deploy the directory to a static web host.
+ Open `git-website/index.html` in a browser or deploy the directory contents to a static web host.
## Licence