branch: externals/ssh-deploy
commit 36186d6d9ffd986040abd66dee99feb9fa372dbe
Author: Christian Johansson <christ...@cvj.se>
Commit: Christian Johansson <christ...@cvj.se>
Replaced sync references with deploy
---
README.md | 19 +++++++++++++++----
1 file changed, 15 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 7f64a47..7fe4b2a 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,15 @@
# `ssh-deploy`
-The `ssh-deploy` plugin makes it possible to effortlessly sync local files
with remote files via SSH. It makes it possible to define remote paths and
whether or not you want to explicitly sync on explicit save actions or not. It
also enabled manual upload and download of files. *You need to have a setup
which allows password-less key-based logins to servers*.
+The `ssh-deploy` plugin makes it possible to effortlessly deploy local files
to remote hosts via SSH. It also makes it possible to define remote paths per
directory and whether or not you want to deploy on explicit save actions or
not. Also it enables manual upload and download of files. You can also check
differences between local file and remote file if you have `tramp` installed.
*You need to have a setup which allows password-less key-based logins to
servers via SSH and have scp inst [...]
-`ssh-deploy` works with `DirectoryVariables` so you can have different sync
setups in different ways for different folders.
+`ssh-deploy` works with `DirectoryVariables` so you can have different deploy
setups in different ways for different folders.
This application is made by Christian Johansson <christ...@cvj.se> 2016 and is
licensed under GNU General Public License 3.
## An example
-* Download ssh-deploy and place it at `~/.emacs.d/ssh-deploy/`. You need to
have `scp` installed locally and enable key-based SSH logins to your remote
hosts.
+* Download ssh-deploy and place it at `~/.emacs.d/ssh-deploy/`.
* Create this `DirectoryVariables` file in your project root at
`/Users/username/Web/MySite/.dir-locals.el`.
@@ -25,10 +25,21 @@ This application is made by Christian Johansson
<christ...@cvj.se> 2016 and is l
(add-to-list 'load-path "~/.emacs.d/ssh-deploy/")
(use-package ssh-deploy)
```
-* Now when you save a file somewhere under the root
`/Users/username/Web/MySite/`, the script will launch and sync the file with
the remote server. You can also trigger a manual deploy by pressing `C-c C-z u`.
+* Now when you save a file somewhere under the root
`/Users/username/Web/MySite/`, the script will launch and deploy the file with
the remote server. You can also trigger a manual deploy by pressing `C-c C-z u`.
+* If you press `C-c C-z x` you will launch a `ediff` session showing
differences between local file and remote file using `tramp`.
+* If you press `C-c C-z u` you will upload local file to remote host.
+* If you press `C-c C-z d` you will download file from remote host and reload
current buffer.
+
+If you want to change the key-binding prefix you only need to set the variable
`ssh-deploy-key-binding-prefix` with something like this:
+
+``` elisp
+(setq ssh-deploy-key-binding-prefix "your-key-binding-here")
+```
The above configuration uses the plugin `use-package` which I highly recommend.
## Read more
* <https://www.emacswiki.org/emacs/DirectoryVariables>
+* <http://www.gnu.org/software/tramp/>
* <https://github.com/jwiegley/use-package>
+* <https://www.emacswiki.org/emacs/EdiffMode>
