Adds troubleshooting notes to address common issues with editing deploy.ini, and removes short-form server declarations, which cause problems for some people.

pocketarc · pocketarc · commit bd328fcb0e9a · 2016-01-03T21:39:08.000Z
diff --git a/deploy.ini b/deploy.ini
@@ -1,15 +1,17 @@
-; This is a sample deploy.ini file.
+; This is a sample deploy.ini file. 
+;
+; NOTES:
+;
+; 1. Don't forget that each server has to have a section title (e.g. [example]).
+; 2. Don't forget to wrap your password around quotes.
+; 3. If you don't specify 'pass', git-deploy-php will let you enter it in the terminal.
 
 [example]
 
 skip = false
-user = example
-; remove this options and enter a password in the terminal
-pass = password
-host = example.com
+user = "example"
+pass = "password"
+host = "example.com"
 port = 21
-path = /path/to/installation
+path = "/path/to/installation"
 passive = true
-
-; If that seemed too long for you, you can specify servers like this:
-[ftp://example:password@example.com:21/path/to/installation]
