update README

Author: liying2008

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change Log
 
 
-## [0.0.1]
+## 0.0.2 (2020-09-22)
+
+- After deployment, delete the local packaging file.
+- Update the README file.
+
+## 0.0.1 (2020-09-21)
 
 - Initial release

README.md

@@ -9,17 +9,21 @@
 
 ## Features
 
-- Select "Build & deploy" to build your project and deploy it to a remote server. 
-- Selecting "Deploy only" will only execute the deployment process.
+- Select "Build & Deploy" to build your project and deploy it to a remote server. 
+- Selecting "Deploy Only" will only execute the deployment process.
 
-![Extension menus](https://github.com/liying2008/easy-deployment/blob/master/pics/extension_commands.png)
+![Extension menus](https://raw.githubusercontent.com/liying2008/easy-deployment/master/pics/extension_commands.png)
 
+Commands in command palette:
+
+![Command palette](https://raw.githubusercontent.com/liying2008/easy-deployment/master/pics/command_palette.png)
 
 ## Extension Settings
 
 This extension contributes the following settings:
 
 ```json
+{
   "easyDeployment.config": {
     "configurations": [
       {
@@ -46,18 +50,66 @@ This extension contributes the following settings:
       }
     ]
   }
+}
 ```
 
+**Details for each configuration item are as follows:**
+
+* `local` configuration (Configuration of local project):
+
+  |  Key   | Defaults | Description |
+  |  ----  | ----  | ----  |
+  | `projectPath`  | . | Project root path (relative path) |
+  | `buildCmd`  | yarn build | Build command for local project |
+  | `outputDir`  | dist | Compiled product output path (relative path) |
+
+* `remote` configuration (Configuration of remote server):
+
+  |  Key   | Defaults | Description |
+  |  ----  | ----  | ----  |
+  | `deploymentPath`  |  | Remote deployment path (absolute path) |
+  | `backupOriginalFiles`  | false | Do you need to back up the original files? |
+  | `backupTo`  | ~/backup | Backup path (absolute path) of the original files |
+  | `deleteOriginalFiles`  | false | Do you need to delete the original files? |
+  | `postCmd`  |  | Command executed after deployment |
+
+* `ssh` configuration (Configuration of ssh connection):
+
+  |  Key   | Defaults | Description |
+  |  ----  | ----  | ----  |
+  | `host`  |  | Hostname or IP address of the server |
+  | `port`  | 22 | Port number of the server |
+  | `username`  |  | Username for authentication |
+  | `password`  |  | Password for password-based user authentication |
+  | `privateKey`  |  | Private key (absolute path) for either key-based or hostbased user authentication (OpenSSH format) |
+
+**Note:**
+
 * Please set it according to your actual needs.
 * You can choose between `password` and `privateKey` in the ssh configuration.
+* If you use `privateKey`, remember to put the local ssh public key into the server's `authorized_keys` file.
+* The remote server needs to be a **Linux** machine.
 * There can be multiple configurations in the outer configurations, and the `name` attribute cannot be repeated.
 
 
 ## Quick Start
 
 - Install [Easy Deployment](https://marketplace.visualstudio.com/items?itemName=liying.easy-deployment).
 - Configure `easyDeployment.config` in `settings.json` in the workspace.
-- Right click in Explorer and select `Build & deploy` or `Deploy only`.
+- Right click in Explorer and select `Build & Deploy` or `Deploy Only`.
+
+
+## Thanks
+
+- [archiverjs/node-archiver](https://github.com/archiverjs/node-archiver)
+- [steelbrain/node-ssh](https://github.com/steelbrain/node-ssh)
+
+
+## Source Code
+
+[https://github.com/liying2008/easy-deployment](https://github.com/liying2008/easy-deployment)
+
+Binary package can be obtained from [this link.](https://marketplace.visualstudio.com/items?itemName=liying.easy-deployment)
 
 
 ## License

package.json

@@ -8,7 +8,7 @@
 		"deploy",
 		"publish"
     ],
-	"version": "0.0.1",
+	"version": "0.0.2",
 	"publisher": "LiYing",
 	"icon": "images/icon.png",
 	"repository": {
@@ -34,12 +34,12 @@
 			{
 				"category": "Easy Deployment",
 				"command": "easy-deployment.buildAndDeploy",
-				"title": "Build & deploy"
+				"title": "Build & Deploy"
 			},
 			{
 				"category": "Easy Deployment",
 				"command": "easy-deployment.deployOnly",
-				"title": "Deploy only"
+				"title": "Deploy Only"
 			}
 		],
 		"menus": {
@@ -59,6 +59,7 @@
 			"properties": {
 				"easyDeployment.config": {
 					"type": "object",
+					"description": "Build and deploy related configurations for `Easy Deployment`",
 					"properties": {
 						"configurations": {
 							"type": "array",
@@ -78,12 +79,12 @@
 											"projectPath": {
 												"type": "string",
 												"default": ".",
-												"description": "Project root path."
+												"description": "Project root path (relative path)."
 											},
 											"outputDir": {
 												"type": "string",
 												"default": "dist",
-												"description": "Compiled product output path."
+												"description": "Compiled product output path (relative path)."
 											},
 											"buildCmd": {
 												"type": "string",
@@ -98,7 +99,7 @@
 										"properties": {
 											"deploymentPath": {
 												"type": "string",
-												"description": "Remote deployment path."
+												"description": "Remote deployment path (absolute path)."
 											},
 											"backupOriginalFiles": {
 												"type": "boolean",
@@ -108,7 +109,7 @@
 											"backupTo": {
 												"type": "string",
 												"default": "~/backup",
-												"description": "Backup path of the original files."
+												"description": "Backup path (absolute path) of the original files."
 											},
 											"deleteOriginalFiles": {
 												"type": "boolean",
@@ -144,7 +145,7 @@
 											},
 											"privateKey": {
 												"type": "string",
-												"description": "Private key for either key-based or hostbased user authentication (OpenSSH format)."
+												"description": "Private key (absolute path) for either key-based or hostbased user authentication (OpenSSH format)."
 											}
 										}
 									}