Merge pull request #2 from cotramarko/fix/unify-naming

Unify naming of tool to `snapvault` and add more extensive description

.goreleaser.yaml

@@ -22,6 +22,7 @@ builds:
       - linux
       - windows
       - darwin
+    binary: snapvault
 
 archives:
   - format: tar.gz

README.md

@@ -4,7 +4,7 @@ A PostgreSQL backup tool that effortlessly captures and restores precise snapsho
 
 ## Usage
 ```shell
-$ snapvault save <snapshot_name> 
+$ snapvault save <snapshot_name> 
 ```
 ```shell
 $ snapvault restore <snapshot_name>

cmd/root.go

@@ -12,14 +12,21 @@ import (
 
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
-	Use:   "sv",
-	Short: "A brief description of your application",
-	Long: `A longer description that spans multiple lines and likely contains
-examples and usage of using your application. For example:
-
-Cobra is a CLI library for Go that empowers applications.
-This application is a tool to generate the needed files
-to quickly create a Cobra application.`,
+	Use:   "snapvault",
+	Short: "A PostgreSQL backup tool for capturing and restoring snapshots of your database.",
+	Long: `A PostgreSQL backup tool for capturing and restoring snapshots of your database.
+
+THe snapvault CLI tool is intended to be used during local development as an easy way to capture
+and restore snapshots of the database, making it possible to quickly restore the database to a
+previous state. It supports basic commands such as "save", "restore", "list" and "delete".
+
+The database URL can be specified in multiple ways. Either by a snapvault.toml file
+(containing url=<connection-string>), or by setting the environment variable
+$DATABASE_URL=<connection-string>, or by passing it as a flag via --url=<connection-string>.
+ 
+The --url flag will always override any of the other ways of specifying the URL. If both a 
+snapvault.toml file is present and $DATABASE_URL is set, then the sv.toml file will be prioritised.
+`,
 	// Uncomment the following line if your bare application
 	// has an action associated with it:
 	// Run: func(cmd *cobra.Command, args []string) { },

internal/engine/config.go

@@ -17,7 +17,7 @@ type DBConfig struct {
 }
 
 const ENV_NAME = "DATABASE_URL"
-const TOML_FILE_NAME = "sv.toml"
+const TOML_FILE_NAME = "snapvault.toml"
 
 func configFromEnv() (config DBConfig, exists bool) {
 	val, exists := os.LookupEnv(ENV_NAME)

tests/commands_test.go

@@ -25,13 +25,13 @@ func TestCoreCommands(t *testing.T) {
 	if err != nil {
 		t.Error(err)
 	}
-	t.Log("Saved fresh")
+	t.Log("Saved `fresh`")
 
 	err = commands.Restore(*e, "fresh")
 	if err != nil {
 		t.Error(err)
 	}
-	t.Log("Restored fresh")
+	t.Log("Restored `fresh`")
 
 	res, err := commands.List(*e)
 	if len(res) != 1 {
@@ -47,5 +47,5 @@ func TestCoreCommands(t *testing.T) {
 	if err != nil {
 		t.Error(err)
 	}
-	t.Log("Deleted fresh")
+	t.Log("Deleted `fresh`")
 }