README.md in vagrant-winrm-syncedfolders-0.1.0 vs README.md in vagrant-winrm-syncedfolders-1.0.0
- old
+ new
@@ -1,23 +1,33 @@
# vagrant-winrm-syncedfolders
-Vagrant plugin that allows you to use WinRM as a folder synchronization mechanism.
+vagrant-winrm-syncedfolders is a Vagrant plugin that allows you to use WinRM as a folder synchronization mechanism.
-*Limitations:* The WinRM communicator that is used to perform the folder synchronization is known to be slow for large numbers of files.
+*Limitations:* The WinRM communicator that is used to perform the folder synchronization is known to be slow for large directories.
## Installation
+*Note:* vagrant-winrm-syncedfolders versions 1.0.0 and later *only* supports
+Vagrant 1.7.4 and later, due to an issue with the version of `winrm-fs`
+bundled with the installer.
+
+Vagrant 1.7.4 users can install this plugin via:
+
vagrant plugin install vagrant-winrm-syncedfolders
+Vagrant 1.7.2 users will need to continue using an old version of the plugin via:
+
+ vagrant plugin install vagrant-winrm-syncedfolders --plugin-version 0.1.0
+
## Usage
Upon installation of this plugin the priority order of synced folders for Windows guests will be as follows:
- - SMB
+ - SMB (Windows host only)
- WinRM
- Rsync
-It is also possible to force a synced folder to use the WinRM:
+It is also possible to force a synced folder to use the WinRM folder sync:
config.vm.synced_folder ".", "/vagrant", type: "winrm"
## Contributing