From 4d44cf806ddfa8d051f2d6b1289fa3b67b0daf2e Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Fri, 21 Oct 2011 17:00:07 -0400
Subject: [PATCH] Cache repository sizes and default metrics for performance boost

---
 docs/01_features.mkd |   45 ++++++++++++++++-----------------------------
 1 files changed, 16 insertions(+), 29 deletions(-)

diff --git a/docs/01_features.mkd b/docs/01_features.mkd
index e31d959..9364710 100644
--- a/docs/01_features.mkd
+++ b/docs/01_features.mkd
@@ -1,14 +1,14 @@
 ## Gitblit Features
 - JGit SmartHTTP servlet
 - Browser and git client authentication
-- Four repository access control configurations with a Read-Only control flag
-    <ul class='noBullets'>
-    <li>![anonymous](blank.png) *Anonymous View, Clone & Push*</li>
-    <li>![push](lock_go_16x16.png) *Authenticated Push*</li>
-    <li>![clone](lock_pull_16x16.png) *Authenticated Clone & Push*</li>
-    <li>![view](shield_16x16.png) *Authenticated View, Clone & Push*</li>
-    <li>![freeze](cold_16x16.png) Freeze repository (i.e. deny push, make read-only)
-    </ul>
+- Four *per-repository* access control configurations with a Read-Only control flag
+    - ![anonymous](blank.png) *Anonymous View, Clone & Push*
+    - ![push](lock_go_16x16.png) *Authenticated Push*
+    - ![clone](lock_pull_16x16.png) *Authenticated Clone & Push*
+    - ![view](shield_16x16.png) *Authenticated View, Clone & Push*
+    - ![freeze](cold_16x16.png) Freeze repository (i.e. deny push, make read-only)
+- Ability to federate with one or more other Gitblit instances
+- JSON RPC interface
 - Gitweb inspired web UI
 - Administrators may create, edit, rename, or delete repositories through the web UI
 - Administrators may create, edit, rename, or delete users through the web UI
@@ -26,39 +26,26 @@
 - Customizable regular expression substitution for commit messages (i.e. bug or code review link integration)
 - Single text file for users configuration
 - Optional utility pages
-    <ul class='noBullets'>
-    <li>![docs](book_16x16.png) Docs page which enumerates all Markdown files within a repository</li>
-    <li>![tickets](bug_16x16.png) Ticgit ticket pages *(based on last MIT release bf57b032 2009-01-27)*</li>
-    </ul>
+    - ![docs](book_16x16.png) Docs page which enumerates all Markdown files within a repository
+    - ![tickets](bug_16x16.png) Ticgit ticket pages *(based on last MIT release bf57b032 2009-01-27)*
 
 ## Gitblit GO Features
 - Out-of-the-box integrated stack requiring minimal configuration
-- Automatically generates a self-signed certificate for https communications
+- Automatically generates a self-signed certificate for *localhost* https communications  
+    (includes script to generate a self-signed certificate for *your hostname*, see [setup](/setup.html) for details)
 - Single text file for configuring server and gitblit
+- A Windows service installation script and configuration tool
 
 ## Limitations
 - HTTP/HTTPS are the only supported protocols
 - Access controls are not path-based, they are repository-based
 - Only Administrators can create, rename or delete repositories
 - Only Administrators can create, modify or delete users
+- Commit hooks are not supported
+- Native Git may be needed to periodically run git-gc as [JGit][jgit] does not fully support the git-gc featureset.
 
 ### Caveats
 - Gitblit may eat your data.  Use at your own risk.
 - Gitblit may have security holes.  Patches welcome.  :)
 
-## Todo List
-- Code documentation
-- Unit testing
-- Update to JGit 1.0.0 when JGit team provides Maven artifacts
-
-### Under Consideration
-- Clone remote repository feature
-- Blob page improvements
-    - view images
-    - view other binary files (pdf, doc, etc)
-- Markdown editing feature
-- Stronger Ticgit read-only integration
-    - activity/timeline
-    - query feature with paging support
-    - change history
-- Ticgit write integration
\ No newline at end of file
+[jgit]: http://eclipse.org/jgit "Eclipse JGit Site"
\ No newline at end of file

--
Gitblit v1.9.1