Add docs

Author: ChappIO

README.md

@@ -0,0 +1,37 @@
+# git-backup
+
+A cli to pull all your GitHub repositories for backup purposes.
+
+## Download
+
+The latest version can be downloaded from the [releases page](https://github.com/ChappIO/git-backup/releases).
+
+## Configuration
+
+Example Configuration:
+```yaml
+# The github section contains backup jobs for
+# GitHub and GitHub Enterprise
+github:
+    # (optional) The job name. This is used to
+    # create a subfolder in the backup folder. 
+    # (default: GitHub)
+  - job_name: github.com
+    # (required) The GitHub personal access
+    # token. Create one with the scopes:
+    # "read:org, repo"
+    # https://github.com/settings/tokens/new?scopes=repo,read:org
+    access_token: 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
+```
+
+## Usage
+
+```asciidoc
+Usage: git-backup
+
+Options:
+  -backup.path string
+        The target path to the backup folder. (default "backup")
+  -config.file string
+        The path to your config file. (default "git-backup.yml")
+```

cmd/git-backup/main.go

@@ -1,13 +1,19 @@
 package main
 
 import (
+	"flag"
 	gitbackup "git-backup"
 	"log"
 	"os"
 	"path/filepath"
 )
 
+var configFilePath = flag.String("config.file", "git-backup.yml", "The path to your config file.")
+var targetPath = flag.String("backup.path", "backup", "The target path to the backup folder.")
+
 func main() {
+	flag.Parse()
+
 	config := loadConfig()
 	for _, source := range config.GetSources() {
 		sourceName := source.GetName()
@@ -23,7 +29,7 @@ func main() {
 		}
 		for _, repo := range repos {
 			log.Printf("Discovered %s", repo.FullName)
-			targetPath := filepath.Join("backup", sourceName, repo.FullName)
+			targetPath := filepath.Join(*targetPath, sourceName, repo.FullName)
 			err := os.MkdirAll(targetPath, os.ModePerm)
 			if err != nil {
 				log.Printf("Failed to create directory: %s", err)
@@ -34,14 +40,13 @@ func main() {
 				log.Printf("Failed to clone: %s", err)
 				os.Exit(100)
 			}
-
 		}
 	}
 }
 
 func loadConfig() gitbackup.Config {
 	// try config file in working directory
-	config, err := gitbackup.LoadFile("./git-backup.yml")
+	config, err := gitbackup.LoadFile(*configFilePath)
 	if os.IsNotExist(err) {
 		log.Println("No config file found. Exiting...")
 		os.Exit(1)
@@ -50,4 +55,4 @@ func loadConfig() gitbackup.Config {
 		os.Exit(1)
 	}
 	return config
-}
+}