Added API definition and improved docs

- Added API definition (./docs/API-1.0.md)
- Fixed typos and improved docs.

Author: datacharmer

Changelog

@@ -1,3 +1,9 @@
+1.0.1	28-Mar-2018
+	- Fixed Issue #5 "Single deployment doesn't show the location of the
+	  sandbox"
+	- Added API definition (./docs/API-1.0.md)
+	- Added test for Issue #5
+	- Fixed typos and improved docs.
 1.0.0	26-Mar-2018
 	- General Availability.
 	- Fixed bug with single deployment and --force. On the second deployment,

README.md

@@ -33,7 +33,7 @@ To use a tarball, you must first run the **unpack** command, which will unpack t
 
 For example:
 
-    $ dbdeployer --unpack-version=8.0.4 unpack mysql-8.0.4-rc-linux-glibc2.12-x86_64.tar.gz
+    $ dbdeployer unpack mysql-8.0.4-rc-linux-glibc2.12-x86_64.tar.gz
     Unpacking tarball mysql-8.0.4-rc-linux-glibc2.12-x86_64.tar.gz to $HOME/opt/mysql/8.0.4
     .........100.........200.........292
 
@@ -45,7 +45,7 @@ For example:
 The program doesn't have any dependencies. Everything is included in the binary. Calling *dbdeployer* without arguments or with '--help' will show the main help screen.
 
     $ dbdeployer --version
-    dbdeployer version 1.0.0
+    dbdeployer version 1.0.1
 
 
     $ dbdeployer -h
@@ -71,7 +71,7 @@ The program doesn't have any dependencies. Everything is included in the binary.
           --config string           configuration file (default "$HOME/.dbdeployer/config.json")
       -h, --help                    help for dbdeployer
           --sandbox-binary string   Binary repository (default "$HOME/opt/mysql")
-          --sandbox-home string     Sandbox deployment direcory (default "$HOME/sandboxes")
+          --sandbox-home string     Sandbox deployment directory (default "$HOME/sandboxes")
           --version                 version for dbdeployer
 
     Use "dbdeployer [command] --help" for more information about a command.
@@ -537,3 +537,13 @@ The lock can also be reverted using
 
     $ dbdeployer admin unlock sandbox_name
 
+## Semantic versioning
+
+As of version 1.0.0, dbdeployer adheres to the principles of [semantic versioning](https://semver.org/). A version number is made of Major, Minor, and Revision. When changes are applied, the following happens:
+
+* Backward-compatible bug fixes increment the **Revision** number.
+* Backward-compatible new features increment the **Minor** number.
+* Backward incompatible changes (either features or bug fixes that break compatibility with the API) increment the **Major** number.
+
+The starting API is defined in [API-1.0.md](https://github.com/datacharmer/dbdeployer/blob/master/docs/API-1.0.md).
+

cmd/defaults.go

@@ -116,7 +116,7 @@ Use "dbdeployer defaults show" to see which values are available`,
 	defaultsExportCmd = &cobra.Command{
 		Use:   "export filename",
 		Short: "Export current defaults to a given file",
-		Long:  `Saves current defaults to a fileer-defined file`,
+		Long:  `Saves current defaults to a user-defined file`,
 		Run:   ExportDefaults,
 	}
 

cmd/root.go

@@ -80,7 +80,7 @@ func init() {
 	cobra.OnInitialize(checkDefaultsFile)
 	// spew.Dump(rootCmd)
 	rootCmd.PersistentFlags().StringVar(&defaults.CustomConfigurationFile, "config", defaults.ConfigurationFile, "configuration file")
-	set_pflag(rootCmd,"sandbox-home", "", "SANDBOX_HOME", defaults.Defaults().SandboxHome, "Sandbox deployment direcory", false)
+	set_pflag(rootCmd,"sandbox-home", "", "SANDBOX_HOME", defaults.Defaults().SandboxHome, "Sandbox deployment directory", false)
 	set_pflag(rootCmd,"sandbox-binary", "", "SANDBOX_BINARY", defaults.Defaults().SandboxBinary, "Binary repository", false)
 
 	rootCmd.InitDefaultVersionFlag()

cmd/unpack.go

@@ -69,7 +69,7 @@ func UnpackTarball(cmd *cobra.Command, args []string) {
 		os.Exit(1)
 	}
 
-	fmt.Printf("Unpacking tarball %s to %s\n", tarball, destination)
+	fmt.Printf("Unpacking tarball %s to %s\n", tarball, common.ReplaceLiteralHome(destination))
 	verbosity_level := unpack.VERBOSE
 	err := unpack.UnpackTar(tarball, Basedir, verbosity_level)
 	if err != nil {