Merge pull request #12 from jtyost2/f/readme-updates

Updates to the readme

README.md

@@ -1,15 +1,6 @@
 # Backup Script #
 
-This script runs and creates daily (stored for 7 days), weekly (stored for 28 days) and monthly (stored for 365 days) of a local webroot and complete database backup of [MySQL](http://www.mysql.com/), [PostgreSQL](http://www.postgresql.org/) and [MongoDB](http://www.mongodb.org/). Each is tared and gzipped and placed in a directory of your choosing and then synched with an [Amazon S3 Bucket](http://aws.amazon.com/s3/) for off-site storage.
-
-## Config Settings and Setup ##
-
-There is a batch of config settings needed to get this running. These are in the `config.sh.default` shell script and none of the them need to be in quotes (as far as I have tested). Copy and rename the `config.sh.default` to `config.sh` and set the values to your particular setup. Copy and rename the `tar_exclude.txt.default` to `tar_exclude.txt` and add any paths/files to be excluded from the tar backup to this file.
-
-## Needed Tools ##
-
-1. Command Line S3 Client: [http://s3tools.org/s3cmd](http://s3tools.org/s3cmd)
-2. AmazonS3 Bucket: [http://aws.amazon.com/s3/](http://aws.amazon.com/s3/)
+This script runs and creates daily (stored for 7 days), weekly (stored for 28 days) and monthly (stored for 365 days) of a local webroot and complete database backup of [MySQL](http://www.mysql.com/), [PostgreSQL](http://www.postgresql.org/), [MongoDB](http://www.mongodb.org/) and [SQLite](https://www.sqlite.org/). Each is tared and gzipped and placed in a directory of your choosing and then optionally synched with an [Amazon S3 Bucket](http://aws.amazon.com/s3/) for off-site storage.
 
 ## Installation ##
 
@@ -20,14 +11,34 @@ There is a batch of config settings needed to get this running. These are in the
 - Git Clone
 	- In your local directory type: `git clone git://github.com/jtyost2/S3_Backup.git S3_Backup`
 
-## To Do ##
+## Usage ##
+
+### Prerequisite Tools ###
+
+1. Command Line S3 Client: [http://s3tools.org/s3cmd](http://s3tools.org/s3cmd)
+2. Optional AmazonS3 Bucket: [http://aws.amazon.com/s3/](http://aws.amazon.com/s3/)
 
-1. Add additional database backups
+### Setup ###
 
-## Possible Issues ##
+There is a batch of configuration settings needed to get this running. These are in the `config.sh.default` shell script and none of the them need to be in quotes (as far as I have tested). Copy and rename the `config.sh.default` to `config.sh` and set the values to your particular setup. Copy and rename the `tar_exclude.txt.default` to `tar_exclude.txt` and add any paths/files to be excluded from the tar backup to this file.
+
+## Possible Issues When Using ##
 
 1. S3Cmd needs to be configured first before use
+2. Recommend use case for running this is via a cron job, ensure the user the cron is running under has access to run the script and the correct permissions for access.
+
+## Contributing ##
+
+### Reporting Issues ###
+
+Please use GitHub Issues for listing any known defects or issues
+
+### Development ###
+
+When working on this script, please fork and issue a PR for any new development.
+
+## License/Copyright ##
 
-## License ##
+[MIT Licensee](https://github.com/jtyost2/S3_Backup/blob/master/COPYRIGHT)
 
 Copyright (c) 2014 Justin Yost