add basic readme and remove cache refresh flag

README.md

@@ -1 +1,90 @@
 # mediarr
+
+Tool to add media to different PVR's in the *arr family.
+
+## Example Configuration
+
+```yaml
+pvr:
+  sonarr:
+    type: sonarr
+    url: https://sonarr.domain.com
+    api_key: your-api-key
+    quality_profile: WEBDL-1080p
+    root_folder: /mnt/unionfs/Media/TV
+    filters:
+      ignores:
+        # tvmaze
+        - 'Provider == "tvmaze" && "English" not in Languages'
+        - 'Provider == "tvmaze" && "Scripted" not in Genres'
+
+        # trakt
+        - 'Provider == "trakt" && "en" not in Languages'
+        - 'Provider == "trakt" && Runtime < 15'
+        - 'Provider == "trakt" && Network == ""'
+        - 'Provider == "trakt" && not (any(Country, {# in ["us", "gb", "au", "ca"]}))'
+
+        # generic
+        - 'Year < (Now().Year() - 5)'
+        - 'Year > Now().Year()'
+        - 'Title contains "WWE"'
+        - 'Title contains "Wrestling"'
+        - '"animation" in Genres || "talk-show" in Genres'
+        - 'len(Genres) == 0'
+        - 'Network in ["Twitch", "Xbox Video", "YouTube"]'
+        - 'Summary contains "transgend" || Summary contains "LGBT" || Summary contains "gay"'
+        - 'Title matches "(?i)ru ?paul.+drag.+"'
+  radarr:
+    type: radarr
+    url: https://radarr.domain.com
+    api_key: your-api-key
+    quality_profile: Remux
+    root_folder: /mnt/unionfs/Media/Movies
+    filters:
+      ignores:
+        # trakt
+        - 'Provider == "trakt" && Runtime < 60'
+        - 'Provider == "trakt" && ("music" in Genres || "documentary" in Genres)'
+        - 'Provider == "trakt" && "en" not in Languages'
+
+        # tmdb
+        - 'Provider == "tmdb" && "en" not in Languages'
+
+        # generic
+        - 'Year < (Now().Year() - 5)'
+        - 'Year > Now().Year()'
+        - 'len(Genres) == 0'
+        - 'Title startsWith "Untitled"'
+        - 'Title contains "WWE" || Title contains "NXT"'
+        - 'Title contains "Live:" || Title contains "Concert"'
+        - 'Title contains "Musical"'
+        - 'Title contains " Edition)"'
+        - 'Summary contains "transgend" || Summary contains "LGBT" || Summary contains "gay"'
+        - 'Title matches "^UFC.?\\d.+\\:"'
+provider:
+  tmdb:
+    api_key: your-tmdb-api-key
+  trakt:
+    client_id: your-trakt-app-client-id
+```
+
+## Example Commands
+
+1. Movies
+
+`mediarr movies radarr trakt -t person --language en --query nicolas-cage --limit 5`
+
+`mediarr movies radarr trakt -t anticipated --language en --country en,us,gb,ca,au --limit 5`
+
+`mediarr movies radarr trakt -t popular --language en --country en,us,gb,ca,au --genre science-fiction --limit 10`
+
+2. TV
+
+`mediarr shows sonarr trakt -t popular --language en --country en,us,gb,ca,au --genre science-fiction --year 2019-2020 --limit 1`
+
+`mediarr shows sonarr trakt -t anticipated --language en --country en,us,gb,ca,au`
+
+
+## Additional Details
+
+All commands support the `--dry-run` flag to mimic the entire run process with the exception of actually adding media to the PVR.

cmd/movies.go

@@ -111,8 +111,6 @@ func init() {
 	_ = moviesCmd.MarkFlagRequired("search-type")
 
 	// optional flags
-	moviesCmd.Flags().BoolVarP(&flagRefreshCache, "refresh-cache", "r", false, "Refresh the locally stored cache.")
-
 	moviesCmd.Flags().IntVar(&flagLimit, "limit", 0, "Max accepted items to add.")
 
 	moviesCmd.Flags().StringVar(&flagQueryStr, "query", "", "Query for search.")

cmd/root.go

@@ -24,7 +24,6 @@ var (
 	flagConfigFile   = "config.yaml"
 	flagDatabaseFile = "vault.db"
 	flagLogFile      = "activity.log"
-	flagRefreshCache = false
 
 	flagSearchType string
 	flagLimit      int

cmd/shows.go

@@ -113,8 +113,6 @@ func init() {
 	_ = showsCmd.MarkFlagRequired("search-type")
 
 	// optional flags
-	showsCmd.Flags().BoolVarP(&flagRefreshCache, "refresh-cache", "r", false, "Refresh the locally stored cache.")
-
 	showsCmd.Flags().IntVar(&flagLimit, "limit", 0, "Max accepted items to add.")
 
 	showsCmd.Flags().StringVar(&flagQueryStr, "query", "", "Query for search.")