From: Jason Woofenden <jason283@herkamire.com>
Date: Fri, 21 Nov 2008 04:00:51 +0000 (-0500)
Subject: updated docs
X-Git-Url: https://jasonwoof.com/gitweb/?p=wfpl.git;a=commitdiff_plain;h=f65ae93001ecad33b7c1518df56a47061bd63c60

updated docs
---

diff --git a/INSTALL b/INSTALL
index 32e8fe3..4894263 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,3 +1,5 @@
+INSTALLING WFPL
+
 This directory must be accessible to your PHP files via the relative path: code/wfpl/
 
 The recommended way to do this is to create a directory named "code" in the
@@ -9,7 +11,10 @@ directory named "wfpl" in the "code" directory described above.
 
 
 
-INSTALLING METAFORM on apache
+INSTALLING METAFORM on apache (OPTIONAL)
+
+Note: metaform is a code generator. It is NOT required to use wfpl. It is a
+tool for auto-generating code for your site which makes use of wfpl.
 
 metaform.php unfortunately has a couple extra steps.
 
@@ -29,7 +34,7 @@ RewriteBase    /metaform/
 RewriteRule    .*\.tgz$  /metaform/index.php
 
 Note: the above .htaccess file assumes that the "metaform" directory you
-created in step one is in the root www directory. If it's in a sub directory
+created in step one is IN the root www directory. If it's in a sub directory
 (for example you access it via: http://example.com/my/sub/dir/metaform/) then
 replace the two occurrences of "metaform" in the .htaccess file with the path
 to that directory (for example "my/sub/dir/metaform").
diff --git a/README b/README
new file mode 100644
index 0000000..f501698
--- /dev/null
+++ b/README
@@ -0,0 +1,22 @@
+WFPL (Well Factored PHP Library)
+
+wfpl is a collection of php functions that make it easy to create websites,
+including things that are tricky to do from scratch like editing databases.
+
+It includes:
+
+* A templating system (so all your data/markup can be in the .html file)
+
+* An easy and secure database API
+
+* Functions to help with input validation and pretty printing of many types of
+  data.
+
+* metaform (early development) a page to auto-generate code for forms (html
+  template, php code, SQL code and even an e-mail template.)
+
+* Easy soft redirects (meaning that in your php code, you can easily specify
+  that you'd like a different php file to handle this request.)
+
+
+wfpl is released under the Gnu GPL v3 or greater.