Merge branch 'patch-2' of https://github.com/lsmith77/ZendSkeletonApplication into...

[zf2.biz/galerie.git] / README.md

diff --git a/README.md b/README.md
index 849078f..b800db8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,31 @@
-Sample, skeleton application using the ZF2 MVC layer.
+ZendSkeletonApplication
+=======================
+
+Introduction
+------------
+This is a simple, skeleton application using the ZF2 MVC layer and module
+systems. This application is meant to be used as a starting place for those
+looking to get their feet wet with ZF2.
+
+
+Installation
+------------
+
+Using Composer (recommended)
+----------------------------
+The recommended way to get a working copy of this project is to clone the repository
+and use composer to install dependencies using the "create-project" command:
+
+    curl -s http://getcomposer.org/installer | php --
+    php composer.phar create-project zendframework/skeleton-application path/to/install
+
+Using Git submodules
+--------------------
+Alternatively, you can install using native git submodules:
+
+    git clone git://github.com/zendframework/ZendSkeletonApplication.git --recursive
+
+Virtual Host
+------------
+Afterwards, set up a virtual host to point to the public/ directory of the
+project and you should be ready to go!