Merge pull request #1 from mpb10/version-2.0.0

Version 2.0.0

README.md

@@ -1,23 +1,15 @@
-
-**DO NOT USE:** Version 2.0 is in progress and will install and work much better.
--
--
--
--
--
--
-
 # PowerShell-Backup-Script
 https://github.com/mpb10/PowerShell-Backup-Script
 
-A PowerShell script used to backup files.
+A PowerShell script used to back up files and folders.
+
 
+**Author: mpb10**
 
-**Author: Matt Bittner**
+**August 13th, 2018**
 
-**June 23th, 2017**
+**v2.0.0**
 
-**v1.1.0**
 #
 
  - [INSTALLATION](#installation)
@@ -29,58 +21,51 @@ A PowerShell script used to backup files.
 
 # INSTALLATION
 
-**Script download link:** https://github.com/mpb10/PowerShell-Backup-Script/archive/master.zip
-
-Note: This script requires Windows PowerShell and 7-Zip to function. PowerShell comes pre-installed with Windows 10 but otherwise can be downloaded here: https://www.microsoft.com/en-us/download/details.aspx?id=50395. 7-Zip can be downloaded here: http://www.7-zip.org/download.html
-
-Make sure your ExecutionPolicy is properly set by opening a PowerShell window with administrator privileges and typing `Set-ExecutionPolicy RemoteSigned`.
+**Script download link:** https://github.com/mpb10/PowerShell-Backup/releases/download/v2.0.0/PowerShell-Backup-v2.0.0.zip
 
-**To Install:** Download the project .zip file, extract it to a folder, and run the `Backup_Installer.ps1` shortcut. The script will be installed to the folder `C:\Users\%USERNAME%\Backup Script`. A desktop shortcut and a Start Menu shortcut will be created. Run either of these to use the script. 
+**Requires:** PowerShell 5.0 or greater*
 
-To update the script, delete the following folder, download the new version and install it:
-
-	C:\Users\%USERNAME%\Backup Script\scripts
-Make sure you don't delete any of the .txt files!
+	*Version 5.0 of PowerShell comes pre-installed with Windows 10 but otherwise can be downloaded here: https://www.microsoft.com/en-us/download/details.aspx?id=50395
 
 #
 
-To uninstall this script, delete the Backup Script folders located at `C:\Users\%USERNAME%\Backup Script` and `%APPDATA%\Microsoft\Windows\Start Menu\Programs\Backup Script`, as well as the desktop shortcut.
-
+**To Install:** 
 
-# USAGE
+1. Ensure that you have PowerShell Version 5.0 or greater installed.
+2. Download the release .zip file and extract it to a folder.
+3. Run the 'Installer' shortcut located in the `\install` folder (or run the the script using the 'PowerShell-Backup - Portable Version' shortcut, navigate to the settings menu, and choose the `2 -  Install script to:` option).
 
-Run either the desktop shortcut or the Start Menu shortcut. At the main menu, choose option `1` to select the folder to be backed up and the folder to which the backup is to be saved. By default the script will backup the user's `Documents` folder to `E:\Backups`. Make sure you choose the proper drive when backing up a folder. Alternatively, users can choose option `2` at the main menu to backup folders listed in the `backuplist.txt` file which is found at `C:\Users\%USERNAME%\Backup Script`.
+A desktop shortcut and a Start Menu shortcut will be created. Run either of those to use the script. The install location is `C:\Users\%USERNAME%\Scripts\PowerShell-Backup`.
 
 #
 
-**New in version 1.1.0**, users can save a list of folders to be backed up in the text file `C:\Users\%USERNAME%\Backup Script\backuplist.txt`. One line at a time, list the path of each folder that is to be backed up, with the first line being the path of where to save the backups. Once the `backuplist.txt` file is set, choose option 2 on the main menu. Confirm that the information is correct and then begin the process.
+To uninstall this script and its files, delete the two folders `C:\Users\%USERNAME%\Scripts\PowerShell-Backup` and `%APPDATA%\Microsoft\Windows\Start Menu\Programs\PowerShell-Backup` and the desktop shortcut.
 
-#
-
-For advanced users, the `backup.ps1` script, which is found in the folder `C:\Users\%USERNAME%\Backup Script\scripts`, can be passed parameters so that this script can be used in conjunction with other scripts or forms of automation. Make sure you have `7z.exe` added to your PATH.
-
-**backup.ps1's parameters are as followed:**
+# USAGE
 
-	-InputPath <path>
-		Folder to be backed up.
-
-	-OutputPath <path>
-		Location where to save the backup.
+Run either the desktop shortcut or the Start Menu shortcut. Use option 1 of the main menu to backup a single folder. Use option 2 and the `Backuplist.txt` file to backup multiple folders at once in a batch job.
 
+Upon being ran for the first time, the script will generate the `BackupList.txt` file in the `\config` folder. To use option `2  - Backup from list` of the main menu, list folder paths under their respective stanzas in the `BackupList.txt` file, save it, and then run option 2 of the script.
 
 # CHANGE LOG
 
+	2.0.0	August 13th, 2018
+		Re-wrote the script in the likeness of PowerShell-Youtube-dl. Cleaned up code.
+		Can backup individual folders or use the BackupList.txt file to run batch jobs.
+		Implemented some logging to the temp folder.
+
 	1.1.1 	June 23rd, 2017
 		Uploaded to Github.
 		Condensed installer to one PowerShell script.
 		Edited documentation.
-
-	1.1.0	June 12th, 2017
-		Added backing up folders listed in backuplist.txt.
-
 
+	1.1.0	June 12th, 2017
+		Added ability to back up folders listed in backuplist.txt.
+		
 # ADDITIONAL NOTES
 
-This script uses the 7-Zip program to compress folders for backing up. 7-Zip is licensed under the GNU LGPL license and its source code can be found at http://www.7-zip.org/.
+**NOTE:** This script utilizes 7-zip command line version 9.20 executable file. This version of 7-zip has been identified as being vulnerable to multiple code execution exploits via crafted archive files. Since the executable is only used to create archives, the danger these vulnerabilities pose are negligable as long as the 7-zip executable is only used by the script to create archives. This version of 7-zip is only used because of its ability to be easily downloaded and installed. To easily mitigate the vulnerabilities found in version 9.20, simply download 7-zip version 18.05 or higher and copy the file `7z.exe` to the `\bin` directory.
+
+This script uses the 7-Zip program to compress folders for backing up. 7-Zip is licensed under the GNU LGPL license and its source code can be found at https://www.7-zip.org/.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.