From 24d08fb7bef89584e0ea39e55aba9fb92bc500e3 Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Thu, 09 Jun 2011 19:41:53 -0400
Subject: [PATCH] Simplified screenshot process and automated thumbnail generation.

---
 docs/00_index.mkd |   51 ++++++++++++++++++++++++++++++++++-----------------
 1 files changed, 34 insertions(+), 17 deletions(-)

diff --git a/docs/00_index.mkd b/docs/00_index.mkd
index 8c8f932..fbd736a 100644
--- a/docs/00_index.mkd
+++ b/docs/00_index.mkd
@@ -31,16 +31,17 @@
 - Repository Owners may edit repositories through the web UI
 - Automatically generates a self-signed certificate for https communications
 - Git-notes support
-- Branch-selectable metrics
+- Branch metrics (uses Google Charts)
+- Blame annotations view
 - Dates can optionally be displayed using the browser's reported timezone
-- Author and Committer email address display can be controlled
+- Display of Author and Committer email addresses can be disabled
+- Case-insensitive searching of commit messages, authors, or committers
 - Dynamic zip downloads feature
-- Markdown view support
-- Syntax highlighting
-- Customizable regular expression handling for commit messages
+- Markdown file view support
+- Syntax highlighting for popular source code types
+- Customizable regular expression substitution for commit messages (i.e. bug or code review link integration)
 - Single text file for server configuration
 - Single text file for users configuration
-- Simple repository stats and activity graph (uses Google Charts)
 - Optional utility pages
     <ul class='noBullets'>
     <li>![docs](book_16x16.png) Docs page which enumerates all Markdown files within a repository</li>
@@ -48,28 +49,36 @@
     </ul>
 
 ### Limitations
+- [%JGIT%][jgit] does not currently [garbage collect or repack](http://www.kernel.org/pub/software/scm/git/docs/git-gc.html)
 - 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
 - Gitblit is an integrated, full-stack solution.  There is no WAR build at this time.
 
+### Caveats
+- Gitblit may eat your data.  Use at your own risk.
+- Gitblit may have security holes.  Patches welcome.  :)
+
 ### Todo List
 - Code documentation
 - Unit testing
-- Branch selector on Metrics
-- Blame
-- Clone remote repository
+- Update Build.java to JGit 1.0.0, when its released
 
 ### Idea List
-- Ticgit activity/timeline
-- Ticgit query feature with paging support
-- Ticgit ticket change history
-- View images on Blob page
-- View other binary files on Blob page
+- Consider clone remote repository feature
+- Consider [Apache Shiro](http://shiro.apache.org) for authentication
+- Stronger Ticgit read-only integration
+    - activity/timeline
+    - query feature with paging support
+    - change history
+- Ticgit write integration
+- Blob page improvements
+    - view images
+    - view other binary files (pdf, doc, etc)
 - Markdown editing feature
 
 ### License
-Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
+Gitblit is distributed under the terms of the [Apache Software Foundation license, version 2.0][apachelicense]
 
 ### Inspirations
 - [Gitweb](http://www.git-scm.com)
@@ -77,7 +86,7 @@
 
 ## Architecture
 
-![block diagram](architecture.png "Git Blit Architecture")
+![block diagram](architecture.png "Gitblit Architecture")
 
 ### Bundled Dependencies
 The following dependencies are bundled with the Gitblit zip distribution file.
@@ -105,6 +114,7 @@
 ### Other Build Dependencies
 - [Fancybox image viewer](http://fancybox.net) (MIT and GPL dual-licensed)
 - [JUnit](http://junit.org) (Common Public License)
+- [commons-net](http://commons.apache.org/net) (Apache 2.0)
 
 ## Building from Source
 [Eclipse](http://eclipse.org) is recommended for development as the project settings are preconfigured.
@@ -124,6 +134,13 @@
     - If running on Linux you may have to change the served port(s) to > 1024 unless you are developing as the root user. 
 6. Execute the *com.gitblit.Launcher* class to start Gitblit.
 
+
+## Contributing
+Patches welcome in any form.
+
+Contributions must be your own original work and must licensed under the [Apache License, Version 2.0][apachelicense], the same license used by Gitblit.
+
 [jgit]: http://eclipse.org/jgit "Eclipse JGit Site"
 [git]: http://git-scm.com "Official Git Site"
-[gitbltsrc]: http://somewhere.com "gitblit git repository"
\ No newline at end of file
+[gitbltsrc]: http://somewhere.com "gitblit git repository"
+[apachelicense]: http://www.apache.org/licenses/LICENSE-2.0 "Apache License, Version 2.0"
\ No newline at end of file

--
Gitblit v1.9.1