(typo)

[vagrant-dotfiles.git] / README.md

diff --git a/README.md b/README.md
index 9b4ecc3..8914b1d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,31 +1,33 @@
-# CopyMyConf
+# vagrant-dotfiles
 
 Now you can copy your dotfiles into your vagrant box, so that you don't feel like visiting Mars whenever you are in vagrant shell.
 
+This project from forked from https://github.com/akshaymankar/copy_my_conf on 9/28/2018.
+
 ## How to Use
 
-It is a simple 3 step process
+It is a simple 2 step process
 
 ### Add gem in your vagrant
 
-    $ vagrant gem install copy_my_conf
+    $ vagrant plugin install vagrant-dotfiles
 
-### Add provisioner in your Vagrantfile
+### Create a ~/.vagrant/dotfiles files
 
-Add these lines in your vagrant file inside the `Vagrant::Config.run` block
+Each line in the file should be a dotfile in your home directory of your workstations.
 
-    config.vm.provision :copy_my_conf do |copy_conf|
-      copy_conf.git = true
-      copy_conf.vim = true
-      copy_conf.ssh = true
-    end
+The plugin will copy this file into your /home/vagrant directory during the 'vagrant up' action.
 
 Don't worry if you have any other provisioners, vagrant can work with multiple provisioners. Yay \o/  
-As you might have guessed, If you make any of these false, the corresponding files won't be copied
 
 If home directory of the user is not `/home/vagrant` then you can specify that using the `user_home` option in above code
 
-      copy_conf.user_home = '/home/some_other_user'
+      config.vm.provision :vagrant-dotfiles do |dotfiles_config|
+          dotfiles_conf.user_home = '/home/some_other_user'
+      emd
+
+Note there are some edge cases with trying to copy your .ssh and .ssh/authorized_keys and .tmpssh* files over so the plugin doesn't clobber
+the vagrant key stored in .ssh/authorized_keys.
 
 ### Fire !
 
@@ -33,11 +35,19 @@ If home directory of the user is not `/home/vagrant` then you can specify that u
 
 And you'll be good to go.
 
+## Development Notes
+
+Reminders for the occasional/accidental rubyist
+
+Rebuilding the gem: gem build vagrant-dotfiles.gemspec
+Running the tests: rspec spec
+Loading the gem to the local dev environment: vagrant plugin install --local ./vagrant-dotfiles-1.0.0.gem
+
 ## Feedback
 This is my first gem so any kind of feedback would be appreciated.  
 Feel free fork, edit and send pull requests.
 
 ## Copyrights & Author
 
-Copyright(c) 2013 Akshay Mankar <itsakshaymankar@gmail.com>  
+Copyright(c) 2018 Jude Nagurney <jude@pwan.org>
 License: [MIT License](http://mit-license.org/)