Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
- Added install directions
- Added DB initialization directions
  • Loading branch information
weierophinney committed Jun 1, 2012
1 parent 639a506 commit 5501667
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions README.md
Expand Up @@ -10,3 +10,46 @@ re-usable modules. The goals are:


This will not and should not be considered a fully-functional, full-featured This will not and should not be considered a fully-functional, full-featured
module, though the basic functionality should work. module, though the basic functionality should work.

Dependencies
------------

* PHP >= 5.3.3
* Zend Framework (current master)
* ZfcUser (current master)

Installation
------------

Via Composer:
-------------
Update your composer.json

{
"require": {
/* ... */
"phly/phly-peep": "dev-master"
}
}

and then run:

php composer.phar install

As a submodule:
---------------

git submodule add git://github.com/weierophinney/PhlyPeep.git vendor/PhlyPeep

All:
----
After installation, update your `config/application.config.php` to add
"PhlyPeep" as a module.

Database Setup
--------------
Currently, PhlyPeep only ships with a schema for SQLite. You can import it using
the following:

$> sqlite3 path/to/database < path/to/phly-peep/data/schema.sqlite.sql

0 comments on commit 5501667

Please sign in to comment.