Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated README

- Added install directions
- Added DB initialization directions
  • Loading branch information...
commit 5501667ec090798cc009b4e967ca807a3d5f3432 1 parent 639a506
@weierophinney authored
Showing with 43 additions and 0 deletions.
  1. +43 −0 README.md
View
43 README.md
@@ -10,3 +10,46 @@ re-usable modules. The goals are:
This will not and should not be considered a fully-functional, full-featured
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
+
Please sign in to comment.
Something went wrong with that request. Please try again.