Installation and static generation

Author: phpfui

.gitignore

@@ -3,8 +3,8 @@
 .picasa.ini
 .viminfo
 vendor/
-www/temp/
-FileManager.json
 *.cache
+*.bat
 phpunit.xml
 
+

.php_cs.dist

@@ -1,7 +1,7 @@
 <?php
 
 $finder = PhpCsFixer\Finder::create()
-  ->in(__DIR__.'\PHPFUI\InstaDoc')
+  ->in(__DIR__.'/src/PHPFUI/InstaDoc')
 ;
 
 return PhpCsFixer\Config::create()

README.md

@@ -4,10 +4,27 @@
 
 We all document our code with PHP [DocBlocks](https://en.wikipedia.org/wiki/PHPDoc) but we never seem to actually generate the documentation and add it to our project. Why? It simply takes too much time (over a minute), so we put it off till later, and later never comes.
 
-But with PHPFUI\InstaDoc, you can document your site in about a minute (OK, maybe 5). The steps involved:
-* Install PHPFUI\InstaDoc via Composer
-* Run installation script
-* Create document page
+But with PHPFUI\InstaDoc, you can document your site in about a minute (OK, maybe 2). The steps involved:
+ * Install PHPFUI\InstaDoc via Composer (30 seconds)
+ * Run installation script (30 seconds)
+ * Create document page (1 minute, 4 lines of code)
+
+ Two minutes to usable documentation with the following features:
+
+## PHPFUI\InstaDoc Features
+ * Always up to date, even with code that is not yet checked in
+ * Documents all projects loaded via Composer automatically
+	* Add any local repo directories
+	* Remove any Composer project you don't care about
+ * Custom ordering of types (const, static, public, protected, etc.)
+ * Alphabetized everything, no more searching unalphabetized pages!
+ * Support for markdown and custom markdown pages
+ * Quick access to highlighed PHP source with user selectable highlighting
+ * Quick access to the file's git history for the local repo
+ * Ability to generate static html files for high volume sites
+ * 4+ line config compatible with all PHP frameworks, or standalone
+ * Completely configureable UI if you don't like the default
+ * Uses [Foundation CSS framework](https://get.foundation) for a great experience on mobile
 
 ### Install PHPFUI\InstaDoc
 composer require phpfui/InstaDoc
@@ -17,7 +34,7 @@ Once installed, you need to run an installation script to copy static files to t
 
 php vendor/phpfui/InstaDoc/install.php yourPublicDirectory/subDirectory
 
-Example: php vendor/phpfui/InstaDoc/install.php public/PHPFUI will add all needed files to public/PHPFUI, which will avoid any conflicts with your current files.  You can specify any directory, but PHPFUI is recomended to keep things simple.
+Example: php vendor/phpfui/instadoc/install.php public/PHPFUI will add all needed files to public/PHPFUI, which will avoid any conflicts with your current files.  You can specify any directory, but PHPFUI is recomended to keep things simple.
 
 ### Create Document Page
 PHPFUI\InstaDoc does not reply on any framework and can run on a standalone page. It is recommended that you do not make your documentation public, as PHPFUI\InstaDoc will display PHP source files. How you restrict access to the page is up to you.  The following does not restrict access and is simply an example:
@@ -35,9 +52,7 @@ That is it. You are done!
 
 #### To Do List:
 
- * Generate static files
  * Create Doc page (the whole point, but do the easy stuff first!)
- * Add installation script
  * Add more documentation
  * Allow for customizable pages (not 100% yet)
  * .git page