README for ReRoute v0.0.2 (beta)

== I. Table of Contents ==
I.  Table of Contents
II. About ReRoute
III.Requirements
IV. Installation
V.  How to use
VI. Contact
VII.Version information 

== II. About ReRoute ==
ReRoute is an application that can serve multiple purposes.
1. Convert long URLs from Google Maps, blog entries, or other such sites into shorter, less visually-offensive URLs.
2. Mask affiliate URLs when a user on your site mouses over a hyperlink.
3. What other purposes have you discovered? Let me know!
ReRoute is able to be installed on your own hosting plan with your own domain.  This means you don't have to send people through other sites like tinyurl.com.  With ReRoute, the URL is of your own domain.

== III. Requirements ==
ReRoute has been tested with MySQL v5.0 and PHP v5.
If issues are discovered with these versions or later, please contact me. If issues are discovered with early versions than those listed above, feel free to contact me, but the priority for support of those issues will not be too high.

== IV. Installation ==
1. Create MySQL database or have existing database available.  ReRoute uses a prefix (reroute_) on all its tables.
2. Create a directory on your server where you want the application to reside.  This will be the path used to access the application (ex: http://www.pwlk.net/rr/ will create urls http://www.pwlk.net/rr/?r=foo).
3. Copy all files and folders into the created directory.
4. Run setup or update script, depending on whether you are setting up ReRoute for the first time (follow part a) or if you are updating ReRoute from a previous version (follow part b).
 a. Point your browser to [install folder]/setup.php (ex: http://www.pwlk.net/rr/setup.php).  **Note: If you want your created URLs to have the 'www' run setup.php from your domain with the 'www'.  If you do not want the 'www', run setup.php from your domain without the 'www'.
 b. Point your browser to [install folder]/update.php (ex: http://www.pwlk.net/rr/update.php).
5. Follow the instructions on the setup pages

== V. How to use ==
1. General user (index.php)
 a. Enter URL you'd like to create a link to
 b. [optional] Enter alpha-numeric extension for created link. Leave blank for a random extension.
 c. Click button to create link.
 d. There is also a link that can be bookmarked (clicked and dragged to bookmark toolbar) so that whatever site you are on, when you click the bookmark, a shortened URL will be automatically generated and displayed.
2. Administrator (admin.php)
 a. First table provides information on all links created.
  i.  Click delete to remove individual entry
  ii. Click blacklist to add IP to blacklist, disabling users from that IP to use the application. This will also delete all URLs that this IP has created.
 b. Blacklist table provides information on all blacklisted IPs
  i.  When a user from a blacklisted IP attempts to create a URL, the '# blocked attempts' increments
  ii. Click remove to remove IP from blacklist
 c. Updating admin information
  i.  appname : readonly
  ii. appversion : readonly
  iii.title : a short (32 characters) custom phrase that will be shown on each page
  iv. domain : readonly
  v.  admin_rows_displayed : number of rows the first table will display on a single page 
  vi. short_domain_length : the maximum number of alphanumeric characters that a short domain will consist of.  When randomly generated, this number will be the length of the short domain every time. Be cautious when changing this value.  Note that you can only increase this value, never decrease.  This is so a longer short_domain can keep its full value and not risk duplicating another short domain if characters needed to be cut off to fulfill a smaller short_domain_length value.
  vii.username : change the username to access the admin page
  viii.new password : change the password to access the admin page

== VI. Contact ==
To contact me, please visit http://www.pwlk.net/contact
If you would like to report an issue with ReRoute, feel free to create a ticket at http://www.pwlk.net/mantis

== VII. Version Information ==
The version number can be interpreted as follows:
 0.0.X : X is incremented when there is a minor update to the GUI, and/or minor update to the feature list
 0.X.0 : X is incremented when there is a moderate update to the GUI, moderate update to the feature list, and/or minor/moderate update to the database
 X.0.0 : X is incremented when there is a major update to the GUI, major update to the feature list, and/or major update to the database

-- 0.0.2 beta --
 Release date: 2009-01-19
 Issues fixed: #10, #13, #12, #9
 Files modified: admin.php, index.php, make_url.php, README.txt
 Files created: analytics.php
 Areas of caution: 
 What's new: 

-- 0.0.1 beta --
 release date: 2009-01-11
 initial release