From cca3f46e43701a1cc387a072694606a88cc0cc60 Mon Sep 17 00:00:00 2001
From: RandomNinjaAtk <RandomNinjaAtk@users.noreply.github.com>
Date: Thu, 26 Jan 2023 16:49:08 -0500
Subject: [PATCH] Update README.md

---
 README.md | 83 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 82 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 214b226..1cae9a7 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,82 @@
-# docker-readarr-extended
\ No newline at end of file
+# [RandomNinjaAtk/readarr-extended](https://github.com/RandomNinjaAtk/docker-readarr-extended)
+[![Docker Build](https://img.shields.io/docker/cloud/automated/randomninjaatk/readarr-extended?style=flat-square)](https://hub.docker.com/r/randomninjaatk/readarr-extended)
+[![Docker Pulls](https://img.shields.io/docker/pulls/randomninjaatk/readarr-extended?style=flat-square)](https://hub.docker.com/r/randomninjaatk/readarr-extended)
+[![Docker Stars](https://img.shields.io/docker/stars/randomninjaatk/readarr-extended?style=flat-square)](https://hub.docker.com/r/randomninjaatk/readarr-extended)
+[![Docker Hub](https://img.shields.io/badge/Open%20On-DockerHub-blue?style=flat-square)](https://hub.docker.com/r/randomninjaatk/readarr-extended)
+
+## Readarr + Extended Script Features
+* [Readarr](https://readarr.com/) Develop (develop branch), base image provided by [LinuxServer.io Team](https://github.com/linuxserver/docker-readarr)
+
+## Supported Architectures
+
+The architectures supported by this image are:
+
+| Architecture | Available | Tag |
+| :----: | :----: | ---- |
+| multi | ✅ | latest |
+| x86-64 | ✅ | amd64 |
+| arm64v8 | ✅ | arm64v8 |
+| arm32v7 | ✅ | arm32v7 |
+
+## Version Tags
+
+| Tag | Description |
+| :----: | --- |
+| latest | Readarr (develop) + Extended Scripts |
+
+## Application Setup
+
+Access the webui at `<your-ip>:8787`, for more information check out [Redarr](https://readarr.com/).
+
+## Parameters
+
+Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
+
+| Parameter | Function |
+| --- | --- |
+| `-p 8787` | The port for the Readarr webinterface |
+| `-v /config` | Configuration files for Readarr. (<strong>required path</strong>)|
+
+## Usage
+
+Here are some example snippets to help you get started creating a container.
+
+### docker
+
+```
+docker create \
+  --name=readarr-extended \
+  -v /path/to/config/files:/config \
+  -p 8787:8787 \
+  -e TZ=America/New_York \
+  -e PUID=1000 \
+  -e PGID=1000 \
+  randomninjaatk/readarr-extended:latest
+```
+
+
+### docker-compose
+
+Compatible with docker-compose v2 schemas.
+
+```
+version: "2.1"
+services:
+  readarr-extended:
+    image: randomninjaatk/readarr-extended:latest
+    container_name: readarr-extended
+    volumes:
+      - /path/to/config/files:/config
+    environment:
+      - TZ=America/New_York
+      - PUID=1000
+      - PGID=1000
+    ports:
+      - 8787:8787
+    restart: unless-stopped
+```
+
+# Credits
+- [LinuxServer.io Team](https://github.com/linuxserver/docker-readarr)
+- [Readarr](https://readarr.com/)
+- [Docker multi-arch example](https://github.com/ckulka/docker-multi-arch-example)