Updating readme

README.md

@@ -1,15 +1,12 @@
-Vendo
-===
+# Vendo
 
-What is it?
----
+## What is it?
 
 A lightweight e-commerce framework developed with the Kohana3 php framework.
 
 It's main goal is to provide an excellent starting base for you to develop e-commerce applications with. It's not designed to be a drop-in e-commerce application, like Magento or OpenCart.
 
-What is special about Vendo?
----
+## What is special about Vendo?
 
  1. It will be easy to build applications with
  2. The source code will make sense
@@ -18,14 +15,12 @@ What is special about Vendo?
  5. Development/Support will be as open as possible. Your contributions are welcome and encouraged
  6. It will be fully tested to ensure stability and prevent issue regression
 
-How can I help?
----
+## How can I help?
 
  1. Create an issue in this project for your feature/request
  2. Follow the [pull request](http://help.github.com/pull-requests/) procedures
 
-How to install Vendo
----
+## How do I use this thing?
 
 Vendo has many parts:
 
@@ -37,56 +32,63 @@ Vendo has many parts:
 
 If you just want to demo the whole vendo-application, do:
 
- 1. Check out this repository with the --recursive flag
- 2. cd to modules/kostache and run `git submodule init` and `git submodule update`
- 3. Install the database:
-    * Run the schema.sql file located in application/schema/
-    * OR (if you are doing development work, use the migrations)
-    * [Liquibase 1.95.](http://www.liquibase.org/download) is used for migrations
-    * Install the database connector. [Mysql](http://dev.mysql.com/downloads/connector/j/) is recommended.
-    * Run `liquibase --driver=com.mysql.jdbc.Driver --classpath=/path/to/mysql-connector-java-5.1.13-bin.jar --changeLogFile=application/schema/schema.xml --url="jdbc:mysql://<hostname>/<database_name>" --username=<username> --password=<password> migrate`
- 4. Make sure the application/photos/ directory is writable by the webserver
+ 1. Check out this repository with the --recursive flag to catch all the submodules (there are a few of them)
+ 2. Install the database: Run the schema.sql file located in application/schema/
+    * The schema file contains table creation for users and roles. If you don't need this (if you are bolting this onto an existing application), simply omit it.
+ 3. Make sure the application/photos/ directory is writable by the webserver
 
 If you'd like to use Vendo to develop your e-commerce application, you can omit the vendo-application module, and use the other four (you still need the database). Sometime in the near future, the modules will be broken into their own repositories.
 
 You can use the vendo-application as a starting point, or for inspiration on how to build an application with Vendo.
 
-Using vendo-application as a base
----
+### Using vendo-application as a base
 
 You can use the vendo-application module as a base for your e-commerce application. If you are happy with the functionality of the stock controllers but not the views (you should probably never use them as-is), you can replace the view class and templates in your application to get a customized skin on top of it.
 
-Testing
----
+### Integrating the vendo user system with your user system
+
+You need to do a bit of work to integrate the user system of vendo into your application. Vendo comes with two "drivers" for this at the moment: ORM and AutoModeler. To use either one, you'll need to put this into your application directory:
+
+	classes/model/vendo/user.php
+
+which contains:
+
+	<?php
+	class Model_Vendo_User extends Model_Vendo_Core_User_ORM
+
+or:
+
+	<?php
+	class Model_Vendo_User extends Model_Vendo_Core_User_AutoModeler
+
+## Testing
 
 One goal of Vendo is to be completely tested. This helps prevent bugs and defines a stable API. We use phpunit for unit tests, and plan on using cucumber for behavior tests once the application ui is stable.
 
 If you contribute code, please make sure that you use TDD or BDD, depending on your contribution.
 
 To run the phpunit tests, simple run `phpunit` from the root of the repository. All tests should pass. Please file an issue if they do not pass on your system.
 
-Integration
----
+## Integration
 
 If you are using the Kohana Template Controller, put this in an extended template controller:
 
-public function after()
-{
-	$this->template->{{$your_body_variable}} = $this->request->response;
+	public function after()
+	{
+		$this->template->{{$your_body_variable}} = $this->request->response;
 
-	return parent::after();
-}
+		return parent::after();
+	}
 
 Then make a templates/layout.mustache file in your application directory with this in it:
 
-{{>body}}
+	{{>body}}
 
 If you take this method, you will need to output the category links, cart link, and the account admin links manually.
 
 This method is untested, so please provide feedback. :)
 
-Tech
----
+## Tech
 
 Here's a list of tech used to build Vendo: