replacing the cli cmds with variables and configuration in config.php
[gwvp-mini.git] / README.md
index 25c8dc8..dca0859 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,13 +3,22 @@ GWVP
 
 ALPHA
 
-GWVP stands for "git over web via php". It was written for one purpose of
-being a quick and simple way of getting a git repo online using only usernames
-and passwords rather then having to deal with ssh keys.
+GWVP stands for "git over web via php". It was written entirely for myself and
+its intention was to have a simple way of managing some git repos that can be
+pulled and pushed to without the overhead of dealing with ssh keys. It also 
+allows the owner to give permissions to a repo such that you can control who
+reads and writes to it. All access to a repo is via http/https using usernames
+and passwords.
+
+Currently the code-base is a bit messy but that will improve over time.
 
 Installation
 ============
 
+Note: the installation assumes the locations for things like "git" and
+git-http-backened, if yours arent in the normal ubuntu locale for that then
+you will need to edit a number of files to point it at the proper location
+
 Ubuntu
 You'll need to add following packages: