From 820c24dadeaa1eee30c818a80a1d045244420375 Mon Sep 17 00:00:00 2001
From: Trevor Slocum <tslocum@gmail.com>
Date: Sun, 14 Apr 2013 18:05:08 -0700
Subject: [PATCH] Update README

---
 README.md | 63 ++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 37 insertions(+), 26 deletions(-)

diff --git a/README.md b/README.md
index 119daf6..e8d6574 100644
--- a/README.md
+++ b/README.md
@@ -1,44 +1,55 @@
-TinyIB
+TinyIB - A Lightweight and Efficient [Image Board](http://en.wikipedia.org/wiki/Imageboard) Script
 ====
 
-Lightweight [image board](http://en.wikipedia.org/wiki/Imageboard) script.  See [example installations](https://github.com/tslocum/TinyIB/wiki) for a demo.
+**Got database? Get speed.**  Use [MySQL](http://mysql.com) or [SQLite](http://sqlite.org) for an efficient set-up able to handle high amounts of traffic.
 
-**Database not required.**  Store posts as text files for a portable set-up capable of running on virtually any PHP host.
+**No database?  No problem.**  Store posts as text files for a portable set-up capable of running on virtually any PHP host.
+
+For demos see [example installations](https://github.com/tslocum/TinyIB/wiki).
 
-**Got database?**  Use [MySQL](http://mysql.com) or [SQLite](http://sqlite.org) for an efficient set-up able to handle high amounts of traffic.
 Features
 ------------
  - Reference links >>###
- - Delete post via password
- - Management panel
-   - Administrators and moderators use separate passwords
-     - Moderators are only able to delete posts
-   - Ban offensive/abusive posters across all boards
-   - Post using raw HTML
-   
+ - Delete post via password.
+ - Management panel:
+   - Administrators and moderators use separate passwords.
+     - Moderators are only able to delete posts.
+   - Ban offensive/abusive posters across all boards.
+   - Post using raw HTML.
+
 Installing
 ------------
 
- 1. CD to the directory you wish to install TinyIB
- 2. Run the command:
+ 1. Verify the following requirements are met:
+    - [PHP](http://php.net) 4 or higher is installed.
+    - [GD Image Processing Library](http://php.net/gd) is installed.
+      - This library is installed by default on most hosts.
+ 2. CD to the directory you wish to install TinyIB.
+ 3. Run the command:
     - `git clone git://github.com/tslocum/TinyIB.git ./`
- 3. Copy settings.default.php to settings.php
- 4. Configure settings.php
- 5. CHMOD write permissions to these directories:
-    - ./
+ 4. Copy **settings.default.php** to **settings.php**
+ 5. Configure **settings.php**
+ 6. CHMOD write permissions to these directories:
+    - ./ (the directory containing TinyIB)
     - ./src/
     - ./thumb/
     - ./res/
     - ./inc/flatfile/ (only if you use flat file for the database)
- 6. Navigate your browser to imgboard.php and the following will take place:
-    - The database structure will be created
-    - Directories will be verified to be writable
-    - The file index.html will be created containing the new image board
+ 7. Navigate your browser to imgboard.php and the following will take place:
+    - The database structure will be created.
+    - Directories will be verified to be writable.
+    - The file index.html will be created containing the new image board.
 
 Updating
 ------------
 
-`git pull`
+ 1. Run the command:
+    - `git pull`
+ 2. If TinyIB has been updated, note which files are modified.
+    - If **settings.default.php** is updated, migrate the changes to **settings.php**
+      - Take care to not change the value of **TINYIB_TRIPSEED**, as it would result in different secure tripcodes.
+    - If other files are updated, and you have made changes yourself, review the modifications ensuring they do not interfere with yours.
+      - Visit GitHub and select the relevant update commit(s) to review what changes were made.
 
 Support
 ------------
@@ -48,7 +59,7 @@ Contact tslocum@gmail.com
 Contributing
 ------------
 
- 1. Read the [GitHub Forking Guide](http://help.github.com/forking/)
- 2. Fork TinyIB
- 3. Commit code changes to your forked repository
- 4. Submit a pull request describing your modifications
+ 1. Read the [GitHub Forking Guide](http://help.github.com/forking/).
+ 2. Fork TinyIB.
+ 3. Commit code changes to your forked repository.
+ 4. Submit a pull request describing your modifications.