From 0f840f9b9f248ef33128f2b3438c89427247f973 Mon Sep 17 00:00:00 2001
From: l3uddz <l3uddz@gmail.com>
Date: Thu, 10 Sep 2020 18:04:56 +0100
Subject: [PATCH] readme: add simple (#1)

---
 .github/workflows/artifact.yml | 18 -----------------
 README.md                      | 37 ++++++++++++++++++++++++++++++++++
 2 files changed, 37 insertions(+), 18 deletions(-)
 delete mode 100644 .github/workflows/artifact.yml

diff --git a/.github/workflows/artifact.yml b/.github/workflows/artifact.yml
deleted file mode 100644
index d0a1ec7..0000000
--- a/.github/workflows/artifact.yml
+++ /dev/null
@@ -1,18 +0,0 @@
-name: prune_artifacts
-on:
-  schedule:
-    # Every 4 hours
-    - cron: '0 */4 * * *'
-
-jobs:
-  remove-old-artifacts:
-    runs-on: ubuntu-latest
-    timeout-minutes: 10
-
-    steps:
-      - name: Remove old artifacts
-        uses: c-hive/gha-remove-artifacts@v1
-        with:
-          age: '1 hour'
-          skip-tags: true
-          skip-recent: 1
\ No newline at end of file
diff --git a/README.md b/README.md
index 6f0650b..cd37cb0 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,38 @@
 # plexarr
+
+Simple CLI tool to fix Plex library matches according to Sonarr/Radarr
+
+## Sample Configuration
+
+```yml
+plex:
+  url: https://plex.domain.com
+  token: your-plex-token
+  database: /opt/plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases/com.plexapp.plugins.library.db
+
+pvr:
+  radarr:
+    - name: radarr
+      url: https://radarr.domain.com
+      api_key: your-radarr-token
+      rewrite:
+        from: /mnt/unionfs/Media/*
+        to: /data/$1
+        
+  sonarr:
+    - name: sonarr
+      url: https://sonarr.domain.com
+      api_key: your-sonarr-token
+      rewrite:
+        from: /mnt/unionfs/Media/*
+        to: /data/$1
+```
+
+## Sample Commands
+
+`plexarr --pvr sonarr --library TV`
+
+`plexarr --pvr radarr --library Movies`
+
+`plexarr --pvr radarr --library Movies-Action --library Movies-Comedy`
+