From d1b3598627704de8ad80073f8faa2ce42ceea292 Mon Sep 17 00:00:00 2001
From: Hassan Khan <me@hassankhan.me>
Date: Mon, 27 Jan 2014 20:37:54 +0000
Subject: [PATCH] [ci-skip] Updated README.md and TODO.md

---
 README.md | 33 ++++++++++++++++++++++++++-------
 TODO.md   | 24 ++++++++++--------------
 2 files changed, 36 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index 9caa2de..524ecb8 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,10 @@ Its interface is _supposed_ to be simple and is in process of documentation. Tha
 
 ## Getting Started
 
+### System Requirements
+
+You need **PHP >= 5.3.0**.
+
 ### Install
 
 #### Composer install
@@ -42,19 +46,30 @@ Then add the following to the top of your ``index.php`` file:
 
 ***Coming soon***
 
-### System Requirements
+### Project setup
+
+After installing the package via Composer, pop open a terminal window, navigate to your project root and type in ``vendor/bin/zep init`` to set up Zepto for its' first run.
 
-You need **PHP >= 5.3.0**.
 
 ### First Run
 
-Instantiate a Zepto application:
+Your project root should now look like this:
 
-    $zepto = new \Zepto\Zepto();
+    .
+    ├── .htaccess
+    ├── composer.json
+    ├── composer.lock
+    ├── config.php
+    ├── index.php
+    └── vendor/
 
-Run the Zepto application:
+Crack open ``index.php`` in your text editor and you'll see
 
-    $zepto->run();
+    require('vendor/autoload.php' );
+    require('config.php');
+
+    $zepto = new Zepto\Zepto($config); // Create instance of Zepto
+    $zepto->run();                     // Run app
 
 ### Setup your web server
 
@@ -80,12 +95,14 @@ You can check out more in-depth documentation [here](https://github.com/hassankh
 
 1. Fork the Zepto repository
 2. Create a new branch for each feature or improvement
+3. Write tests so my precious code coverage doesn't decrease (too much)
 3. Send a pull request from each feature branch to the **develop** branch
 
-It is very important to separate new features or improvements into separate feature branches, and to send a pull request for each branch. This allows me to review and pull in new features or improvements individually.
+It's pretty important to separate new features or improvements into separate feature branches, and to send a pull request for each branch. This allows me to review and pull in new features or improvements individually.
 
 ### Style Guide
 
+4 space tabs, snake case method names please.
 ***Coming soon***
 
 ### Unit Testing
@@ -94,6 +111,8 @@ All pull requests should ideally be accompanied by passing unit tests and comple
 
 ## Community
 
+Don't make me laugh
+
 ### Forum and Knowledgebase
 
 **Coming soon**
diff --git a/TODO.md b/TODO.md
index f690e35..7c65674 100644
--- a/TODO.md
+++ b/TODO.md
@@ -1,8 +1,6 @@
 To-Do
 ====
 
-## Project organisation
-
 ## Frontend
 - Rewrite CSS to LESS
 - Probably try and use Bootstrap
@@ -15,29 +13,27 @@ To-Do
 - Fix headers for consistency
 
 ## Application
+- [Add support for environments ``[production|dev]``](https://github.com/hassankhan/Zepto/issues/4)
 - Abstract-ify Whoops
+- Move ``index.php`` to ``public`` folder
+- Check for PHP version and use newer functions where available
 
 ## Router
-- Add functionality to allow for
-    - DELETE
+- Add functionality to allow for other HTTP verbs
 
 ## Templating Engine
 - Add Twig extensions
 
 ## Plugins
-- Make plugins Pimple Objects
-- Remove all hardcoded paths from PluginLoader
 - Add hooks to important parts of application by adding ``run_hooks()`` calls
-    - ``after_config_load`` isn't working at the minute, need to decouple it some
+    - [``after_config_load`` isn't working at the minute, need to decouple it some](https://github.com/hassankhan/Zepto/issues/5)
 
-## Tests
+## [Tests](https://github.com/hassankhan/Zepto/issues?milestone=1&state=open)
 - Write MORE unit tests
     - Add @dataProvider to ConsoleTest
 - Maybe get some benchmarks up?
-- Add support for HHVM
+- [Add support for HHVM](https://github.com/hassankhan/Zepto/issues/3)
 
-## Miscellanea
-- Move ``index.php`` to ``public`` folder
-- Add support for environments ``[production|dev]``
-- Check for PHP version and use newer functions where available
-- Create a CLI-type tool for initial setup [IN PROGRESS]
+## ``zep``
+- Make init wizard
+- Make shortcuts for ``zep new`` like ``zep new -p Test`` for a new plugin called TestPlugin.php