summary history branches tags files
commit:6fe5a9715b04546571eae809733f0527fb082e30
author:Trevor Bentley
committer:Trevor Bentley
date:Sun Jan 15 02:41:05 2023 +0100
parents:84c9f70f221bed630ba7362277c39e0a5b85ee03
Limitations section in readme
diff --git a/README.md b/README.md
line changes: +6/-0
index 5d0afdd..c488bfb
--- a/README.md
+++ b/README.md
@@ -170,6 +170,12 @@ All metadata of all repositories, except for file contents, is held in memory.  
 
 Small repositories with dozens to hundreds of commits can be generated on the order of a few seconds or less.  Large repositories take *considerably* longer; parsing 1,000,000 commits from the Linux kernel repository with `limit_tree_depth = 3`, `limit_context = 10` and `limit_diffs = 100` took ~30 minutes on a fast laptop, and produced a ~2GB website.
 
+## Limitations
+
+* Only indexes history of one branch.
+* No permalinks.  Links to file contents are invalidated if the file changes.
+* High memory usage for large repositories.
+* Limited to the pre-defined set of input templates.
 
 ## Main Dependencies