more docs

cli/config.go

@@ -11,14 +11,22 @@ import (
 type Config struct {
 	path string
 
-	Secret          string `json:"secret"`
-	DefaultLocale   string `json:"default_locale"`
-	Domain          string `json:"domain,omitempty"`
-	Format          string `json:"format,omitempty"`
+	// Project auth token. You can find the auth token in your project overview or project settings form.
+	Secret string `json:"secret"`
+	// Default locale  your PhraseApp project (default is en).
+	DefaultLocale string `json:"default_locale"`
+	// Set a domain for use with Gettext translation files (default is phrase).
+	Domain string `json:"domain,omitempty"`
+	// Specify a format that should be used as the default format when downloading files (default is yml).
+	Format string `json:"format,omitempty"`
+	// Set the target directly to store your localization files retrieved by phrase pull. Allows placeholders: https://github.com/phrase/phrase#allowed-placeholders-for-advanced-configuration
 	TargetDirectory string `json:"target_directory,omitempty"`
+	// Set the directory that contains your source locales (used by the go-phrase push command). Allows placeholders: https://github.com/phrase/phrase#allowed-placeholders-for-advanced-configuration
 	LocaleDirectory string `json:"locale_directory,omitempty"`
-	LocaleFilename  string `json:"locale_filename,omitempty"`
-	Encoding        string `json:"encoding,omitempty"`
+	// Set the filename for files you download from PhraseApp via phrase pull. Allows placeholders: https://github.com/phrase/phrase#allowed-placeholders-for-advanced-configuration
+	LocaleFilename string `json:"locale_filename,omitempty"`
+	// Set the encoding for your localization files to UTF-8, UTF-16 or Latin-1. Please note that the encodings only work for a handful of formats like IOS .strings or Java .properties. The default will be UTF-8. If none is provided the default encoding of the formats is used.
+	Encoding string `json:"encoding,omitempty"`
 }
 
 // Config stores locale specific configuration options